The accordions in the documentation show unformatted markdown syntax

[teolemon]

What

• The accordions in the documentation show unformatted markdown syntax
• @alexgarel proposed we have a specific readme file for the rendered documentation

Part of

• 📝 Documentation (tracker) #7744

[thestarsahil]

What exactly have to change ?

[alexgarel]

@thestarsahil we should add a index.md in docs (and stop making it from README.md in the generate documentation action, but I can add it).

This index.md should introduce the documentation sections.

Also we discussed changing the way the doc is structured, either we do it first, or your new index should clearly separate API / Developer topics.
see:

• Change documentation structure to have API and Developers docs at top level #8104

[thestarsahil]

@alexgarel I want to work on this section
Can I ?

[alexgarel]

Go @thestarsahil :-)

[github-actions]

This issue is stale because it has been open 90 days with no activity.