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

Design docs from main repo #19

Closed
gdcutting opened this issue Feb 22, 2019 · 3 comments
Closed

Design docs from main repo #19

gdcutting opened this issue Feb 22, 2019 · 3 comments
Assignees
Labels

Comments

@gdcutting
Copy link
Collaborator

gdcutting commented Feb 22, 2019

Get design doc posted here so we can link from .io page. Post user manual at .io too?

occam-ra/occam#32

@gdcutting gdcutting self-assigned this Feb 22, 2019
@gdcutting gdcutting pinned this issue Feb 22, 2019
@gdcutting
Copy link
Collaborator Author

After discussing with Joe I think it's best to let the docs live at the main repo and just link to that page from the .io site. I'm very close to having the user manual and working design docs up at upstream repo.

@gdcutting
Copy link
Collaborator Author

Now that I've gotten https://occam.readthedocs.io/en/latest/ going, I feel much better about moving forward on a number of doc-related things. One of those is to get some links added to the .io page. In particular, I want to link the Getting Started page and the readthedocs page (above) linked from the .io page somewhere. Will work on that this weekend

@gdcutting
Copy link
Collaborator Author

This is taken care of by the creation of the readthedocs.org hosted docs page (https://occam.readthedocs.io), which are now linked from the 'getting started' page. Further doc development can all take place at main repo (https://www.github.com/occam-ra/occam), and those docs will be served by readthedocs.org and can be linked from here.

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

No branches or pull requests

1 participant