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

Add basic documentation #10

Open
macro1 opened this issue Dec 7, 2015 · 2 comments
Open

Add basic documentation #10

macro1 opened this issue Dec 7, 2015 · 2 comments

Comments

@macro1
Copy link
Member

macro1 commented Dec 7, 2015

Some basic documentation should be added which can be published in a readable way. Possibly with 'Read the Docs' or something similar, since that is popular with many libraries.

Detail isn't important for this. Just a clean base so more documentation sections can be added later.

@willingc
Copy link
Member

willingc commented Dec 7, 2015

@macro1 I'm happy to mentor/pair with someone interested in using RestructuredText, Sphinx, and Read the Docs.

@davidfischer
Copy link
Member

To start on this one, I think we just need some more details in the README. If that goes well, we can expand to a full docs/ directory and Read the Docs. To start, we need sections on:

  • What the repository is about
  • Contributing to the site
    • Setting up the dev environment, running tests, etc.
    • Issues to work on, etc.
  • Where the site lives (eg. pythonsd.org)
  • How to use the site for your own meetup!
  • Deploying the site

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

No branches or pull requests

3 participants