Bring documentation into front-end application

[chrisdburr]

User Role

Developer

Goal / Desire

As a developer, I want to implement docusaurus or Astro starlight

Benefit / Reason

So that we can improve the documentation platform by ensuring everything is integrated into one place

Acceptance Criteria

• Existing structure for documentation is maintained
• Documentation is stored in markdown files (or MDX), to allow easy editing
• Similar UI elements to those in Material are preserved
• When merged to main, documentation is recreated and available on the main site

Additional Notes / Considerations

No response

[RichGriff]

@chrisdburr here are some screens of the documentation site.

Please note: It didnt work having the sidebar in the bright colour, so i opted to style the navbar. It still uses the same colours and isnt a world apart from the application.

Figure 1: Documentation in light mode with all the same docs in the current main branch

Figure 2: API Documentation in dark mode, I opted to section this off so it would be easy for users to quickly access the api configurations.

[RichGriff]

"When merged to main, documentation is recreated and available on the main site"

This doesn't matter now. As the documentation is part of the frontend application it will reflect the code for staging and production. So if a doc has been added in staging it will only appear in staging site until that push has been made into production.

[RichGriff]

@chrisdburr this is now in staging for review

[chrisdburr]

Thanks, @RichGriff.

In general, this looks good. However, there are some issues with callout formatting and some missing images across a number of pages.

How would you like to handle this?

I can do a general review if you open a PR, or I can create a new branch from develop.

[RichGriff]

Hey @chrisdburr thanks for taking a look.

Probably best to highlight any issues here along with screenshots to support. I think I initially removed some images to prevent build errors when they didn't exist. if you can let me know which pages these are (with a link to the 'old' docs site - even better). I can also look at adding these for you.