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

Recommend some documentation tooling #84

Open
aanand opened this issue Jun 14, 2021 · 2 comments
Open

Recommend some documentation tooling #84

aanand opened this issue Jun 14, 2021 · 2 comments

Comments

@aanand
Copy link
Contributor

aanand commented Jun 14, 2021

Now that we have a section on documentation, it'd be good to recommend some workflows and tooling for writing and publishing docs, as @tashian suggested.

@Rubix982
Copy link
Contributor

Rubix982 commented Aug 3, 2021

By documentation tooling, are we talking about tools such as GitHub pages, Sphinx, or ReadTheDocs? Those are common ways developers generate documentation for their code, and setup workflows that can help automate, push, and publish those pieces of documentation.

@eqn-group
Copy link

By documentation tooling, are we talking about tools such as GitHub pages, Sphinx, or ReadTheDocs? Those are common ways developers generate documentation for their code, and setup workflows that can help automate, push, and publish those pieces of documentation.

I think documentation should be distributed as text or pdf or single page html format only. hyperlinks can be used to refer from one section to another. It is preferrable to distribute your program manual along with the program itself off-line.
offline tooling must be the priority.

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

3 participants