docs: move developer instructions to bottom of README#43
Merged
Conversation
Agent-Logs-Url: https://github.com/jmf-pobox/txt2tex/sessions/73bc897a-9ae7-49fe-a9b6-5781098465af Co-authored-by: jmf-pobox <155204947+jmf-pobox@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
jmf-pobox
April 26, 2026 16:09
View session
There was a problem hiding this comment.
Pull request overview
Reorganizes the README to separate developer/contributor setup guidance from user-facing installation and usage docs, improving readability for end users.
Changes:
- Moved the “For Developers (git clone)” block out of the Installation section into its own top-level section near the bottom of the README.
- Updated the Examples cross-reference from “above” to “below”.
- Adjusted heading levels within the moved developer section to match the new nesting.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| cd examples && make | ||
|
|
||
| # Convert a file | ||
| txt2tex myfile.txt |
There was a problem hiding this comment.
The dev setup uses uv sync and earlier examples use uv run ..., but this section later suggests running txt2tex myfile.txt directly. Unless the user has activated the created virtualenv or installed txt2tex globally, txt2tex may not be on PATH. Consider switching this to uv run txt2tex ... (or explicitly mention activating .venv) to keep the workflow consistent and avoid “command not found” for contributors.
Suggested change
| txt2tex myfile.txt | |
| uv run txt2tex myfile.txt |
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.
README mixed user-facing and developer content, with the "For Developers (git clone)" block embedded mid-page inside Installation.
Changes
####headings inside the moved section to###to match the new top-level contextNew section order: Why → Installation → Quick Start → What You Can Write → Usage → Syntax Reference → Examples → LaTeX Options → IDE → Overleaf → Troubleshooting → Limitations → Status → Documentation → For Developers → Contributing → License → Credits
Note
Low Risk
Documentation-only reordering with a small anchor reference tweak; no runtime or build logic changes.
Overview
Moves the README’s developer-focused setup (clone instructions,
makecommands, and ethos agent-team notes) out of the Installation area into a new top-level## For Developers (git clone)section placed near the end of the document.Updates the Examples section cross-reference to point below (since the section moved) and adjusts heading levels within the moved block to fit its new top-level placement.
Reviewed by Cursor Bugbot for commit fc81e33. Bugbot is set up for automated code reviews on this repo. Configure here.