liatrio / liatrio/engineering-bootcamp
Migrate from docsify to mkdocs
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 49
- Forks
- 52
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 30
Description
org has moved to mkdocs as our preferred documentation static site generator due to its support in Backstage TechDocs.
Bootcamp migration has some complexities due to the custom plugins that we have. Mkdocs looks to support this but more research is needed
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the repository's existing docsify setup and custom plugins, then compare them with MkDocs plugin support in the linked configuration guide. Done means the bootcamp documentation runs successfully on MkDocs with its required custom plugin behavior preserved.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100