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

Improving Documentation #27

Open
3 tasks done
Soft opened this issue Aug 23, 2017 · 2 comments
Open
3 tasks done

Improving Documentation #27

Soft opened this issue Aug 23, 2017 · 2 comments

Comments

@Soft
Copy link
Contributor

Soft commented Aug 23, 2017

Nitro is currently lacking in documentation, this should be improved. I am creating this issue to track the progress of documentation project.

As of what the documentation should contain, as a starting point, I think we should have:

  • Basic API Documentation: Basic documentation of classes and functions.
  • Higher-Level Description of Project Structure: What are the different components and the relationships between them.
  • Example Usage: It could be nice if we had some simple examples of how the framework could be used. How to write new backends etc.
@Soft
Copy link
Contributor Author

Soft commented Aug 30, 2017

I've been writing basic api documentation on a separate branch that is based on my multiple backends work as I hope it gets eventually merged. The current progress can be seen here.

@Soft Soft mentioned this issue Sep 11, 2017
@Soft
Copy link
Contributor Author

Soft commented Oct 13, 2017

Just to update this issue accordingly, I think most of the things described here have been done. Of course you could still have more documentation and the existing documentation could probably use a complete read through to spot any missing things, broken sentences, and remaining typos.

Wenzel added a commit that referenced this issue Dec 13, 2017
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