Skip to content
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

Manual: Reorganize Chapters 2 and 3 #2029

Merged
merged 1 commit into from
May 28, 2024

Conversation

Omikhleia
Copy link
Member

Chapter c02

  • Corrected apostrophes from straight to curly.
  • Reorganized content flow to enhance coherence
    • Previously, the sequence oscillated between topics.
      We had: Setting up an editor (not the first thing I'd would have put an accent on), typing a SILE document (but we can't do anything with it yet), installing SILE, back to the SILE document (repetitive) for running instructions.
    • Now, it follows a more logical order:
      1. Installing SILE (straight on topic, we want it installed!).
      2. Setting up an editor (ok, let's finish setting up things...)
      3. Typing a SILE document and executing it (yay! fun things all grouped)

Chapter c03

  • Corrected apostrophes, quotes and some typos.
  • Adopted a more formal tone (and avoid comparing with past versions)
  • Rewrote most of the introductory section on input languages (with ideas from the Wiki, and also a bit of AI assistance in the rephrasing)
  • Removed some redundant/repeated content
  • Corrected sectioning levels which did not seem consistent

@Omikhleia Omikhleia requested a review from alerque as a code owner May 10, 2024 19:42
@Omikhleia Omikhleia added the documentation Documentation bug or improvement issue label May 10, 2024
@Omikhleia Omikhleia added this to the v0.15.0 milestone May 12, 2024
Copy link
Member

@alerque alerque left a comment

Choose a reason for hiding this comment

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

Thanks! There will be some merge conflicts with some edits I was working on for install instructions but I'll take care of those, the copy edits and organizational sanity are much more important than a little merge effort!

@alerque alerque merged commit 5e5aba1 into sile-typesetter:develop May 28, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation bug or improvement issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants