Skip to content

Instantly share code, notes, and snippets.

@nitin42

nitin42/wiki.md Secret

Created February 24, 2017 16:55
Show Gist options
  • Save nitin42/4d48b94d682a124e2ea73a77aac73828 to your computer and use it in GitHub Desktop.
Save nitin42/4d48b94d682a124e2ea73a77aac73828 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
wiki.md

Introduction

How to install and use mathsteps.

Usage

Different objects that mathsteps provides or returns (like Node, NodeStatus and Equation). How they represent the different steps in mathsteps. How tree traversal works

Glossary

Here you can explain the different components of the codebase. (breaks the abstraction for a normal user)

API reference

Self explanatory.

Change logs

Every release or some migration instructions can be added here instead of creating another markdown file which will contain the updates or changes.

Feedback

Any request user makes or so.

Troubleshooting

We can make some examples for the use cases considering the scenarios where the user is stucked somewhere. (optional)

Recipes

Here we can add some examples or code snippets so that users can use mathsteps in their own codebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment