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

Docs are a bit clunky #1

Open
rkday opened this issue Jul 20, 2014 · 0 comments
Open

Docs are a bit clunky #1

rkday opened this issue Jul 20, 2014 · 0 comments

Comments

@rkday
Copy link
Contributor

rkday commented Jul 20, 2014

Because the files in this repository generate the whole SIPp site (including docs for previous versions still in use), there are a lot of similar directories (e.g. https://github.com/SIPp/sipp-docs/tree/master/src/documentation/content/xdocs/doc3.2 and https://github.com/SIPp/sipp-docs/tree/master/src/documentation/content/xdocs/doc3.3).

Also, the docs are written in Apache Forrest, which is not very widely used. Long-term, I'd prefer to move to AsciiDoc and host the docs on https://read-the-docs.readthedocs.org/en/latest/getting_started.html. This would also interact with version control, so we could use git tags for building previous versions of the docs, in the same way we mark actual previous releases of the code.

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

1 participant