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

consider: Docusaurus as documentation framework #1320

Open
11 tasks
DaveSkender opened this issue Jan 18, 2025 · 0 comments
Open
11 tasks

consider: Docusaurus as documentation framework #1320

DaveSkender opened this issue Jan 18, 2025 · 0 comments
Assignees
@DaveSkender
Labels
documentation Improvements or additions to documentation experiment Pseudo-fork for experimental (do not merge)
Milestone
v3

Comments

@DaveSkender
Copy link
Owner

Convert our Ruby/Jekyll documentation site in the /docs folder into an equivalent Docusaurus site. The high level tasks are to:

  • Add [Docusaurus](https://docusaurus.io)
  • Remove Jekyll site entirely
  • Migrate all basic site configurations from the old Jekyll site to the new Docusaurus site
    • HTML meta, SEO, and web vitals configs
    • Handle production vs preview site
  • Update build/deploy GitHub Action workflows for doc site for
    • Accessibility (a11y) testing
    • HTML URL checker
    • Website deployment
    • Add/remove GitHub secrets and variables as needed
  • Migrate all content from the old site to the new site

Example site: playwright.dev

Related to:
@DaveSkender DaveSkender added documentation Improvements or additions to documentation experiment Pseudo-fork for experimental (do not merge) labels Jan 18, 2025
@DaveSkender DaveSkender added this to the v3 milestone Jan 18, 2025
@DaveSkender DaveSkender self-assigned this Jan 18, 2025
@DaveSkender DaveSkender moved this from Maybe to Do Next in Stock Indicators for .NET Jan 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DaveSkender DaveSkender

Labels
documentation Improvements or additions to documentation experiment Pseudo-fork for experimental (do not merge)
Projects
Stock Indicators for .NET
Status: Do Next
Milestone
v3
Development

No branches or pull requests
1 participant
@DaveSkender