-
Notifications
You must be signed in to change notification settings - Fork 7
Open
Labels
P2Design ready to devDesign ready to devdocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Prerequisites
- I have searched for duplicate or closed feature requests
- I have read the contributing guidelines
Proposal
Following #603, here are some ideas to improve the documentation:
- Create a real landing page versionless
- Create a real landing page for each version
- Create a branch
gh-pagesprobably to have all our minor versions stored somewhere (Add a script to ease the documentation release process) - Create a version picker to navigate between versions
- Create aliases for pages so we can always access to the last version of the page
- Provide some components to mutualize code (Cards for Examples or Use cases pages, Examples for the iframes we have, ...)
- Use built-in Prism component (https://docs.astro.build/fr/guides/syntax-highlighting/#prism- and https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/blob/main/site/src/components/shortcodes/Code.astro)
- Create a file to have global variables such as the docs version, etc...
Motivation and context
Better our documentation.
Metadata
Metadata
Assignees
Labels
P2Design ready to devDesign ready to devdocumentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request