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.

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

[Spike] New docs: find the best documentation site generator for our needs #7398

Closed
tkajtoch opened this issue Dec 5, 2023 · 0 comments
Closed
Assignees

Comments

@tkajtoch
Copy link
Member

tkajtoch commented Dec 5, 2023

Summary

We need a documentation site generator to meet our requirements and help us deliver better documentation quicker.

Acceptance Criteria

  • This spike should result in publishing a decision record and getting stakeholders' approvals on the chosen software

Decision drivers

  • Supports Markdown, MDX, or similar
  • Allows separation of text content and component previews
  • Is written in React for easy customization and maintainability
  • Supports custom themes
  • Is proven to be stable
  • Doesn't seem to be at risk of deprecation within the next 3+ years
  • Generates static HTML, CSS, and JS without the need to run a dedicated app server
  • Supports Markdown/MDX extensions
  • Supports or could support full-text search
  • Is accessible out-of-the-box and allows for more a11y improvements
  • Is SEO-friendly
@tkajtoch tkajtoch self-assigned this Dec 5, 2023
@tkajtoch tkajtoch closed this as completed Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant