[Docs] Split readme md

[peter-csala]

Pull Request

The issue or feature being addressed

• 📖 De-monolith the README #3365

Details on the issue fix or feature implementation

• As a first step to de-monolith the README.md I've created 6 separate md files (one for each configure and customize section).
• I also updated the readme.md to point ot the new documentation files.

Preview: https://github.com/peter-csala/Swashbuckle.AspNetCore/tree/3365-split-readme-md

Additional stuff:

• I've changed the headings for the subsection to one level lower
  • in the readme.md the sections start from H2 level
  • in the new md files they start from H1 level
• I've removed the # suffixes because they are not needed and they were used inconsistenly
• I've replaced the explicit <h3> tags under the Redoc to markdown syntax

Otherwise the content remain intact.

The next PR will improve the formatting of the markdown files.

[peter-csala]

@dotnet-policy-service agree

[peter-csala]

@martincostello Could you please review it?

[martincostello]

I've been travelling for work this week. This is in my TODO pile until I have the time to look at it properly on a computer.

[martincostello]

Could we delete the equivalent content in README in this PR too please? Then we won't have the content in two places.

It can be as simple as leaving the headings in place with a simple "See here" link to each section that links to the new page. We can make it look nicer later on.

Otherwise LGTM.

[peter-csala]

Could we delete the equivalent content in README in this PR too please? Then we won't have the content in two places.

It can be as simple as leaving the headings in place with a simple "See here" link to each section that links to the new page. We can make it look nicer later on.

Otherwise LGTM.

Done

[martincostello]

Thank you!

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.55%. Comparing base (1c0259f) to head (70c0545).
Report is 2 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3405      +/-   ##
==========================================
+ Coverage   83.65%   93.55%   +9.90%     
==========================================
  Files          84      110      +26     
  Lines        3291     3834     +543     
  Branches      579      719     +140     
==========================================
+ Hits         2753     3587     +834     
+ Misses        538      247     -291     

Flag	Coverage Δ
Linux	93.55% <ø> (+9.90%)	⬆️
Windows	93.55% <ø> (+9.90%)	⬆️
macOS	93.55% <ø> (+9.90%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.