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

Improve Exhibit documentation #172

Open
lmorillas opened this issue Jul 27, 2016 · 4 comments
Open

Improve Exhibit documentation #172

lmorillas opened this issue Jul 27, 2016 · 4 comments

Comments

@lmorillas
Copy link
Contributor

We should improve and reorganize exhibit documentation.

Old exhibit 2 and exhibit 3 docs are mixed.

Do you have a plan about it @karger ?

@karger
Copy link
Member

karger commented Jul 27, 2016

yes, we've begun some improvements and will be pushing them out soon.

On 7/27/2016 3:55 AM, Luis Miguel Morillas wrote:

We should improve and reorganize exhibit documentation.

Old exhibit 2 and exhibit 3 docs are mixed.

Do you have a plan about it @karger https://github.com/karger ?


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#172, or mute the
thread
https://github.com/notifications/unsubscribe-auth/ABFpXkCxfaiOJx-SARKsKs7gfaKE14hbks5qZw8HgaJpZM4JV7en.

@lmorillas
Copy link
Contributor Author

Cool. Tell us if you want collaboration.

@karger
Copy link
Member

karger commented Jul 27, 2016

always! what do you think you can contribute?

On 7/27/2016 11:09 AM, Luis Miguel Morillas wrote:

Cool. Tell us if you want collaboration.


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#172 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/ABFpXq_zmaSf8PGCaHzdQN06bFVkScrDks5qZ3S_gaJpZM4JV7en.

@jaygray0919
Copy link

Here's an idea.
Use ReadTheDocs (https://readthedocs.org/) and Sphinx as the documentation platform.
Create an Exhibit documentation Github repo.
Use Webhooks to periodically update RTD with new or changed documentation.
Then the community could author pages on the subjects about which they are knowledgeable.
Source format is .rst using docutils (http://docutils.sourceforge.net/) which is a superset of markdown.
@karger should probably set the outline - top level menus.
Contributors like @lmorillas and others active participants on Google Groups then can could work on a menu branch.
Overtime, the best of EX2 and EX3 could be merged with community contributions.
The working version will always be irregular, as with any work-in-progress.
But the Sphinx/.rst documentation services enable multi-media explanation/illustrations.

/jay

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

3 participants