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: MkDocs as documentation framework #1297

Open
11 tasks
DaveSkender opened this issue Dec 25, 2024 · 0 comments
Open
11 tasks

consider: MkDocs as documentation framework #1297

DaveSkender opened this issue Dec 25, 2024 · 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

DaveSkender commented Dec 25, 2024 •
edited
Loading

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

  • Add MkDocs
  • Remove Jekyll site entirely
  • Migrate all basic site configurations from the old Jekyll site to the new MkDocs 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
@DaveSkender DaveSkender added documentation Improvements or additions to documentation experiment Pseudo-fork for experimental (do not merge) labels Dec 25, 2024
@DaveSkender DaveSkender added this to the v3 milestone Dec 25, 2024
@DaveSkender DaveSkender self-assigned this Dec 25, 2024
@DaveSkender DaveSkender mentioned this issue Dec 25, 2024
Draft
10 tasks
@DaveSkender DaveSkender moved this from Maybe to In Progress in Stock Indicators for .NET Dec 25, 2024
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: In Progress
Milestone
v3
Development

When branches are created from issues, their pull requests are automatically linked.

mkdocs-baseline DaveSkender/Stock.Indicators
1 participant
@DaveSkender