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

Kill the SIL :) #73

Open
Omikhleia opened this issue Dec 12, 2023 · 1 comment
Open

Kill the SIL :) #73

Omikhleia opened this issue Dec 12, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Omikhleia
Copy link
Owner

Omikhleia commented Dec 12, 2023

The resilient manual still has several files in SIL (typically, the class chapter)

It also mentions SIL a lot (e.g. in package descriptions).

For people who use Markdown or Djot, the usage is not always straightforward. I am sure we can do better.

EDIT: Ideally, the user guide is intended for people with no knowledge of SIL, and even no knowledge of SILE and TeX-like typesetters, but just a basic knowledge of Markdown, to be at ease.1 So it's ok to give pointers to SIL commands, or SILE Lua internals, but the main text body should eventually clear without knowing these things.

Footnotes

  1. Even in-depth knowledge of YAML shouldn't be assumed, i.e. examples have to be clear enough so that users can start tinkering, and learn on the way.

@Omikhleia Omikhleia added the documentation Improvements or additions to documentation label Dec 12, 2023
@Omikhleia Omikhleia added this to the 2.2.1 milestone Dec 12, 2023
@Omikhleia
Copy link
Owner Author

Not going to do this for milestone 2.2.1 - Running late on everything.

@Omikhleia Omikhleia removed this from the 2.2.1 milestone Dec 15, 2023
@Omikhleia Omikhleia added the good first issue Good for newcomers label Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant