Consider recommending great-docs for documentation module
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Start by locating the documentation module section that currently covers MkDocs, then read the linked great-docs documentation and repository. Compare its Python 3.11+ requirement and Quarto-based workflow with the course setup. Done means the evaluation has a documented conclusion about whether great-docs should be recommended or added.
Written by the indexing model from the issue text.
Description
The documentation module currently covers MkDocs. great-docs from Posit is a new Python documentation site generator worth evaluating as an alternative or addition.
Why it's interesting for this course
- Built on Quarto — same toolchain the course already uses for slides
- Zero-config API reference — auto-discovers public API from docstrings (NumPy, Google, Sphinx formats)
- Minimal setup —
great-docs init/build/preview, no templates or manual page authoring needed - Modern defaults — dark mode, responsive, sidebar search, GitHub integration
- AI-ready — generates
llms.txtfiles
Links
- Documentation
- GitHub
- PyPI (requires Python 3.11+)
- Dominant language
- Jupyter Notebook
- Stars
- 8
- Forks
- 1
- Avg merge
- 4m
- Merged PRs (30d)
- 1
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.
More from DHI/python-package-development
-
Difficulty 2/5 1-2 days Newbie friendliness 88/100
-
Difficulty 2/5 1-2 days Newbie friendliness 72/100
DHI/python-package-development#37 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
All issues in DHI/python-package-development
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·