post: Great Docs (Ten Great Things We Added to Great Docs)#238
Open
rich-iannone wants to merge 6 commits into
Open
post: Great Docs (Ten Great Things We Added to Great Docs)#238rich-iannone wants to merge 6 commits into
Ten Great Things We Added to Great Docs)#238rich-iannone wants to merge 6 commits into
Conversation
Publishing checklist
|
✅ Deploy Preview for posit-open-source canceled.
|
Blog YAML Checks✅ All 1 posts passed. |
rich-iannone
requested review from
cwickham,
gregswinehart,
ivelasq and
jeroenjanssens
as code owners
t-kalinowski
approved these changes
May 13, 2026
|
|
||
| The practical consequence is that you don't have to enumerate your exports by hand. If you add a new class or function to your package, the next build picks it up. If you remove something, it disappears from the site. The configuration file exists so you can reorder sections, add display names, or exclude internal symbols, but the default is complete and correct without any having to do any manual intervention. | ||
|
|
||
| I suppose this was the design decision that everything else built on: if Great Docs can figure something out automatically, it should, and configuration should be for expressing preferences rather than providing information that we could have inferred. |
Member
There was a problem hiding this comment.
Suggested change
| I suppose this was the design decision that everything else built on: if Great Docs can figure something out automatically, it should, and configuration should be for expressing preferences rather than providing information that we could have inferred. | |
| This was the design decision that everything else built on: if Great Docs can figure something out automatically, it should, and configuration should be for expressing preferences rather than providing information that we could have inferred. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the "Ten Great Things We Added to Great Docs" blog post at
content/blog/great-docs-ten-things/. The post surveys ten features shipped across ten releases of Great Docs (v0.1throughv0.10.0), one highlight per release, tracing the project's evolution from a fairly simple docs generator into a more comprehensive platform for Python package documentation.The post covers auto-discovery, SEO and proofreading, documentation linting, internationalization, keyboard navigation, page tags and status badges, scale-to-fit, versioned documentation, color swatches, and table previews/explorer. It includes several screenshots demonstrating features in context, links to some relevant User Guide pages, and a closing invitation for readers to submit feature ideas. Reading time is around 10 minutes.
Test plan
/blog/with the correct title, thumbnail, and descriptionsoftware: great-docstag in frontmatter resolves to the Great Docs software pagevalidate-blog-posts.pyCI check passesTODO (later PR)
great-docssoftware entry with description and logo