Refresh README #609
Merged
Refresh README #609
Conversation
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
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #609 +/- ##
=======================================
Coverage 44.03% 44.03%
=======================================
Files 22 22
Lines 2305 2305
Branches 362 362
=======================================
Hits 1015 1015
Misses 1143 1143
Partials 147 147 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tony
force-pushed
the
refresh-markdown
branch
2 times, most recently
from
e0f7912 to
0e0d408
Compare
why: Following libvcs pattern, each code example should link to deeper documentation for users who want to learn more. what: - Add "Learn more" links to quickstart sections (workspace setup, pane interaction, traversal, pytest plugin) - Add inline links in features list (traverse, context managers, pytest) - Add pytest fixture code example showing session fixture usage - Reorganize project links into Topics / Reference / Project groups - Link all 6 topic pages: traversal, pane_interaction, workspace_setup, automation_patterns, context_managers, options_and_hooks
tony
force-pushed
the
refresh-markdown
branch
from
ab887fd to
122ecdf
Compare
why: New filtering topic should be discoverable from README. what: - Add "Learn more about Filtering" link in List and filter sessions section - Add Filtering to Topics list in Project links
why: Users should be able to jump directly to API reference from the core concepts table. what: - Link Server/Session/Window/Pane to their respective API pages - Add note about Options and Hooks abstractions with links
why: The centered logo/badges div from README shouldn't bleed into the sphinx docs - use :start-after: to skip it. what: - Add "# libtmux" as page title - Use :start-after: </div> to skip the centered header section
why: The horizontal rule appears in sphinx docs when using :start-after: </div> - not needed since header is visually distinct.
why: The hide-toc frontmatter was suppressing the sidebar ToC, and the toctree directive was malformed (stray :hidden: outside block). what: - Remove hide-toc: true frontmatter - Remove stray "## Table of Contents" and ":hidden:" text - Add :hidden: to first toctree directive (matches libvcs pattern)
Member
Author
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. 🤖 Generated with Claude Code |
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.
No description provided.