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

Symposion, Pinax Project Symposion, PinaxCon Docs #126

Open
KatherineMichel opened this issue Mar 4, 2016 · 3 comments
Open

Symposion, Pinax Project Symposion, PinaxCon Docs #126

KatherineMichel opened this issue Mar 4, 2016 · 3 comments

Comments

@KatherineMichel
Copy link
Member

Hi, I'm creating an issue for contributing to Pinax Symposion docs. I brought this up in Slack on Feb 29. I offered to help document PinaxCon, but also noticed pinax-project-symposion after that and could help with this at the same time. The Symposion Docs seems like the logical place to document this...? Here is a possible new structure for the index.rst

.. toctree::
:maxdepth: 2
:caption: Symposion Apps

project
conference
content
proposals
sponsorship
speakers
schedule

.. toctree::
:maxdepth: 2
:caption: Starter Projects

pinax-project-symposion
pinaxcon

.. toctree::
:maxdepth: 2
:caption: Examples

I got the caption info from here: http://www.sphinx-doc.org/en/stable/markup/toctree.html#toctree-directive

The new detail pages would be something like:
pinax-project-symposion
pinaxcon

The examples part could either be a hyperlink directly to project (DjangoCon, PyCon website repos, ect) or a detail page for each project to give more explanation and hyperlink... ?

These are just my initial thoughts, btw. Could be changed, but it is similar in format to https://github.com/pinax/pinax/blob/master/docs/index.md though. Does anyone else have any thoughts?

Update, March 12: I also just discovered that there are docs for PyCon, based on Pinax Symposion. This could also be somehow referenced.... https://pycon.readthedocs.org/en/latest/

@ossanna16
Copy link
Contributor

This looks great @KatherineMichel! Thank you! @jtauber Any thoughts/comments?

@KatherineMichel
Copy link
Member Author

Thanks! They have a lot of issues going on, so if it takes some time, it's ok. :)

@ossanna16
Copy link
Contributor

Thank you for being patient! :)

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

2 participants