Skip to content

Commit eea69cb

Browse files
lesnik512claude
andauthored
docs: point root README at the site, profile, and deploy runbook (#2)
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 047ef04 commit eea69cb

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
1-
# .github
1+
# .github
2+
3+
Organization-level configuration and the public website for the
4+
[Modern Python](https://github.com/modern-python) GitHub organization.
5+
6+
- **Website:** [modern-python.org](https://modern-python.org) — built from `docs/`
7+
with MkDocs + Material and deployed to GitHub Pages via
8+
[`.github/workflows/deploy.yml`](.github/workflows/deploy.yml) on every push to `main`.
9+
- **Org profile:** [`profile/README.md`](profile/README.md) renders on the
10+
organization's GitHub landing page.
11+
- **Deployment & domain setup:** see [`docs/DEPLOYMENT.md`](docs/DEPLOYMENT.md).
12+
13+
## Local development
14+
15+
```bash
16+
uv run mkdocs serve
17+
```

0 commit comments

Comments
 (0)