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

Markdown-like package and module documentation #22

Open
uliska opened this issue Jun 10, 2017 · 0 comments
Open

Markdown-like package and module documentation #22

uliska opened this issue Jun 10, 2017 · 0 comments

Comments

@uliska
Copy link
Contributor

uliska commented Jun 10, 2017

Each package and each module directory should have a README.md file (as that's what is e.g. automatically displayed on Github). These should be used as the general package/module description/documentation.

To be discussed is whether this needs some specific form or has a special range of formatting options. This has to be discussed in the context of which kind of tool we'll use to process the Markdown files. It should be very strongly recommended to use or build upon an existing tool like Pandoc, Gitbook or other Markdown-based site builders.

A specific question is whether these pages should include code examples with images. I see two options here:

Blocks #26

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

1 participant