`great-docs` by Posit Is here!

Open
#1,587 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
jupyter, python
Domain
documentation

Research direction

Read the great-docs documentation linked in the issue and inspect nbdev's existing documentation-generation workflow. Determine whether a concrete integration path exists, then document the findings or define the integration work clearly enough for implementation.

Written by the indexing model from the issue text.

Description

Posit just released their latest documentation tool for Python packages: https://posit-dev.github.io/great-docs/

I'm getting the conversation going in this issue as it will inevitably come up. I'm not sure how easy it will be to drop it in to nbdev, but I will give it a try!

Dominant language
Jupyter Notebook
Stars
5.3k
Forks
514
Avg merge
2d 30m
Merged PRs (30d)
8

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AnswerDotAI/nbdev

All issues in AnswerDotAI/nbdev

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.