Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bring documentation into front-end application #648

Open
4 tasks
chrisdburr opened this issue Nov 8, 2024 · 0 comments
Open
4 tasks

Bring documentation into front-end application #648

chrisdburr opened this issue Nov 8, 2024 · 0 comments

Comments

@chrisdburr
Copy link
Collaborator

chrisdburr commented Nov 8, 2024 •
edited
Loading

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Trustworthy and Ethical Assurance Platform (Feature Roadmap)
Status: Ready
Milestone
No milestone
Development

No branches or pull requests
1 participant
@chrisdburr