-
Notifications
You must be signed in to change notification settings - Fork 165
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
Make corrections to docs #1065
Make corrections to docs #1065
Conversation
Repo is displayed at top right of book.
Codecov Report
@@ Coverage Diff @@
## master #1065 +/- ##
==========================================
+ Coverage 45.83% 45.85% +0.02%
==========================================
Files 171 171
Lines 64145 64180 +35
==========================================
+ Hits 29398 29427 +29
- Misses 34747 34753 +6
... and 29 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Wow, thank you! I appreciate the careful editing and polish that you've put in here. The changes aren't always obvious but I think that it's quite valuable to correct things like "which"/"that" mistakes, and clearly you've given things a close read. If you're motivated, any further contributions to the documentation are extremely welcome — unfortunately, Tectonic has heretofore continued the long-standing TeX tradition of having rather poor HTML documentation, which is something that I would love to see change. I have my own projects aiming to tackle that, but I've completely overwhelmed by work responsibilities lately (I feel like I've been writing that for the past 3-4 years ...) and it would be fantastic to have more people working on things! |
Thanks! I'm glad my contributions are welcome. Hopefully, as I get more in tune with the code, I'll find more things to improve or add to the documentation. |
Hi! This is my first time contributing to this project, and I hope to make (many) more contributions.
This PR generally "updates" the Tectonic book. The substance of these updates is ensuring the documented command usage matches the actual usage displayed by the CLI. This fixes #1057 and other issues people may open about this.
To review those corrections, you can look at these commit ranges:
Since I am doing some bulk text changing and formatting anyway, I thought I would include grammar fixes in this PR as well. Those make up the rest of the file changes.