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

Use asciidoctor for user guide #39

Open
moaxcp opened this issue Mar 7, 2017 · 0 comments
Open

Use asciidoctor for user guide #39

moaxcp opened this issue Mar 7, 2017 · 0 comments

Comments

@moaxcp
Copy link
Owner

moaxcp commented Mar 7, 2017

The user guide should be written in asciidoctor. Figure out how asciidoctor will work for this project and implement it. At the end of this task there should be some basic guidance for graph-dsl.

Basic Documentation to Add

  1. Using graph-dsl with with grape
  2. Add vertices and edges
  3. show actual code and results from running actual code

Problems to solve

  1. ensure the version of graph-dsl in scripts is updated from gradle
  2. include code from documentation scripts
  3. include results from running documentation scripts

Documentation policy

Some policies should be made on how to introduce new features in the guide. How to tag code for use in asciidoctor. When to display results from example code.

When something is first used include all the code. After it is introduced including all the code is not needed. For example, show the usage of the static graph {...} method once and then after that section of the documentation the developer should assume code is run from within a dsl entry point.

@moaxcp moaxcp changed the title Use asciidoctor in gradle Use asciidoctor for user guide Jul 3, 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