Skip to content

Naively split the "Overview" page into child pages #748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 2, 2025

Conversation

zanieb
Copy link
Member

@zanieb zanieb commented Jul 1, 2025

I don't think this is "good", but it splits each top-level heading of the existing documentation into a dedicated page as a starting point.

@@ -82,11 +82,21 @@ extra:
- icon: fontawesome/brands/x-twitter
link: https://x.com/astral_sh
nav:
- Overview: index.md
- Introduction: index.md
- Concepts:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll want an index.md here eventually so the header is clickable like the other ones, but we'll want to settle on the content first to avoid churn.

Base automatically changed from zb/docs to feat/docs July 1, 2025 19:14
possibly-unbound-import = "error"
```

## Suppressions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This chapter was missing completely, added.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh tragic, it's sitting untracked in my repo — not sure why that one got missed. Thanks for catching it!

@sharkdp sharkdp marked this pull request as ready for review July 2, 2025 10:07
Copy link
Contributor

@sharkdp sharkdp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@sharkdp sharkdp merged commit 367e5cb into feat/docs Jul 2, 2025
4 checks passed
@sharkdp sharkdp deleted the zb/docs-ii-nav branch July 2, 2025 10:09
zanieb added a commit that referenced this pull request Jul 2, 2025
Splits each top-level heading of the existing documentation into
a dedicated page as a starting point.

---------

Co-authored-by: David Peter <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants