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

Write basic docs #3

Open
thoward opened this issue Dec 13, 2017 · 2 comments
Open

Write basic docs #3

thoward opened this issue Dec 13, 2017 · 2 comments

Comments

@thoward
Copy link
Owner

thoward commented Dec 13, 2017

Include, at minimum:

  • some usage examples
  • a description of what RST features are covered, and what the expected output will be (e.g. what kind of tag, and what CSS class)
  • a description of what RST features are NOT covered, and how those are output/handled
  • explain the relationship to the parser project, and which things are handled by parser, but not by renderer, vs things just not handled by parser at all
  • add a "contributing" section, including basic dev docs on how to make changes, run tests, publish new version of the package, etc.
@Tythos
Copy link

Tythos commented May 7, 2019

I wouldn't mind adding some docs, especially since there are some other features I'd love to add support for and should probably make sure they're written up before I submit a PR. What level of detail and organization did you have in mind? An extended README? Full docs folder? JSDoc generation?

@Tythos
Copy link

Tythos commented Dec 8, 2020

UPDATE: See PR #10

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants