docs: fix drifted facts in the org profile, site, and contributor docs - #124
Merged
Merged
Conversation
- Delete brand/STORY.md and brand/story-assets/ (nothing else referenced them) - Use each repo's pyproject description for every row in profile/README.md and docs/index.md (httpware, templates, DI, services, utilities) - Add chat-app to the profile, site catalog, project marks, and site link check - CONTRIBUTING: point to just lint-ci / just lint, drop the "where a justfile exists" clause, say that-depends is the repo that runs mypy and pyrefly - brand/README: describe the chevron icon, drop the done header-logo follow-up - Reword the that-depends and migration-guide lines and the standard.md opener
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
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.
Summary
A review of the org repo found facts that drifted from their sources. Each was checked against the source before changing it.
Changes
brand/STORY.mdandbrand/story-assets/. A grep of the whole repo (mkdocs.yml, tests, brand build scripts, READMEs) found no references outside STORY.md itself.brand/README.mddid not link to it.profile/README.md: the httpware row said "Python HTTP client framework with sync & async clients and built-in resilience".httpware/pyproject.tomlsays "Typed, resilient HTTP clients for Python, sync and async" (MD1). Every other profile row already matched its pyproject.docs/index.mdcatalog: every row now uses its repo's pyprojectdescription. Rows that had drifted: both templates (the litestar one was missing "with DI"), modern-di, all modern-di-* integrations (modern-di-pytest called itself a plain integration), that-depends, lite-bootstrap, httpware, faststream-redis-timers, faststream-concurrent-aiokafka, faststream-outbox, db-retry, eof-fixer, and semvertag. The list separator is now:instead of an em dash. The httpware row now uses the pyproject string, which supersedes the "add circuit breaker" fix. The stack section atdocs/index.md:77already lists retry, bulkhead, and circuit breaker.chat-app, a public repo, to the Project templates table and the site catalog. It useschat-app/pyproject.toml's description: "Reference chat application for the modern-python organisation".tests/test_profile.pyrequires every profile row to have a project mark, so it also gets a MANIFEST entry inbrand/build/projects.py. Like the templates, it reuses the org chevron because it is not a published library. Its rendered assets are inbrand/projects/chat-app/, and it is added toscripts/check_site_content.sh.CONTRIBUTING.md: every sibling repo has a justfile, so the "where a justfile exists" clause is gone. The suggested checkuv run ruff check .applies fixes because the canonical ruff config setsfix = trueandunsafe-fixes = true, so the step now points tojust lint-ci, which is read-only, andjust lint, which fixes. The templates and chat-app have nolint-cirecipe, and the text says so. Of the sibling justfiles, onlythat-depends/justfile:11-12,17-18runs mypy and pyrefly.brand/README.md: the icon is a chevron between the two snakes (brand/build/geometry.py:6-17,_icon_markdraws a<polyline>chevron), so it no longer mentions a gold core dot. The header logo follow-up is done (mkdocs.yml:16logo: assets/mark.svg, built bygeometry.mark), so that section is removed.docs/standard.mdopener is rewritten too.Follow-ups, not changed here:
brand/build/projects.py::DOCS_REPOSsocial-card taglines are the old home page one-liners, for example httpware's "(retry, bulkhead)". Changing them means regenerating the social cards.Checklist
ruff) (this repo has no lint recipe)ty)uv run pytest: 172 passed;uv run mkdocs build --strictclean;scripts/check_site_content.shpasses;lychee --offlinereports 0 errors)uv build) if packaging or build config changeddescription, profile blurb) if this touches packaging (except the chat-app GitHub description noted above)