Skip to content

Conversation

@vyrnix9582046173
Copy link

@vyrnix9582046173 vyrnix9582046173 commented Mar 11, 2020

This PR creates a Gitbook documentation site based on prior work from #1, Contexture repository README documentations, and other Contexture resources.

Gitbook enables bi-directional syncing with GitHub, which allows for changes to be easily made from GitHub and reflected onto the documentation pages on Gitbook.

  • The content is not completed, the incomplete sections have TODO in them.
  • The content instructions and code have not all been tested and may be outdated since the original draft ([WIP] First Draft #1).

See this PR live: https://doc.contexture.site/
Gitbook: https://app.gitbook.com/@ltchris/s/contexture/


Possibly fixes smartprocure/contexture#16 and possibly fixes #2.

This PR is similar to #5 , the difference being Gitbook offers a different style and format for handling the documentation. Gitbook is easier to read and higher quality IMO.


NOTE: before merging, the Gitbook pages settings would possibly need to be updated for the

  • custom domain (currently pointed to https://doc.contexture.site/ )
  • the repo it syncs with (currently pointing to ltchris/contexture-docs - master and gitbook* branches)

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

Successfully merging this pull request may close these issues.

Include more explained examples of core code Documentation

2 participants