Skip to content
This repository has been archived by the owner on Jul 26, 2020. It is now read-only.

Create documentation #209

Open
4 of 11 tasks
beeman opened this issue Jan 16, 2017 · 4 comments
Open
4 of 11 tasks

Create documentation #209

beeman opened this issue Jan 16, 2017 · 4 comments

Comments

@beeman
Copy link
Member

beeman commented Jan 16, 2017

  • Decide on what to use for documentation
  • Set up basic structure
  • Document the following subjects
    • Design choices
      • Framework versions, etc
      • Data model
      • Directory structure
    • Extending the project
    • Contributing
      • MD file in Project Root
      • Templates for issues/PR's
@beeman beeman added this to the Colmena CMS v1.0.0-beta milestone Jan 16, 2017
@beeman beeman mentioned this issue Jan 16, 2017
5 tasks
@pulkitsinghal
Copy link
Contributor

pulkitsinghal commented Feb 16, 2017

GitHub Wiki is good but gitbook.com is better ... and its free for open source ... I'm using it for https://training.shoppinpal.com and loving the markdown syntax.

@beeman
Copy link
Member Author

beeman commented Feb 17, 2017

Thanks for your input @pulkitsinghal, I've already made a small start on GitBook https://colmena.gitbooks.io/developers-guide/content/. I like working with it a lot too!

The repo is getting synced here https://github.com/colmena/colmena-docs

@pulkitsinghal
Copy link
Contributor

pulkitsinghal commented Feb 18, 2017

@beeman - can I get access to contribute to:
a) either the gitbook.com account
b) or the backend repo via my gitbook desktop editor?

@beeman
Copy link
Member Author

beeman commented Feb 18, 2017

@pulkitsinghal more than welcome 👍 thanks!

Just added you to the GitHub and GitBook org!

@beeman beeman added this to Ready in Initial release Jun 12, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Development

No branches or pull requests

2 participants