NASA-IMPACT / NASA-IMPACT/veda-docs
Documentation Platform Evaluation
Open
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 10
- Forks
- 16
- Avg merge
- 2d 31m
- Merged PRs (30d)
- 4
Description
In order to improve our veda-docs site and maintenance of our docs, we should explore alternatives to Quarto.
Acceptance Criteria
- assess if an alternative to Quarto (MKdocs, Sphinx, Jekyll site, etc.) is more appropriate for the veda-docs site - ADR required (in
veda-architecture) - define evaluation criteria (Ease of contribution via GitHub, native support for Jupyter notebooks, theming, navigation, extensibility)
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
Start by reviewing the current veda-docs site and its Quarto setup. Compare Quarto with the named alternatives using the criteria in the issue, including GitHub contribution, Jupyter notebook support, theming, navigation, and extensibility. Done means the criteria are defined and an ADR in veda-architecture records the evaluation and recommendation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jekyll, jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100