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.

Sign up for GitHub

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

Jump to bottom

[doc] Refactor the documentation #611

Closed

frbattid opened this issue Nov 13, 2015 · 1 comment

Assignees

Labels

doc

Milestone

Member

frbattid commented Nov 13, 2015

Current README is too long and information starts being difficult to find.

Thus, the documentation must be refactored into this set of documents:

README: It must shorter in order the user really read it. The README must contain a brief description on Cygnus, how to install and test it and useful links to the detailed documentation.
Quick Start Guide: It must be moved from doc/ to the root folder.
doc/ folder: It must be refactored into a real documentation folder, holding all the pages a readthedocs for Cygnus must have.

The text was updated successfully, but these errors were encountered:

frbattid added the doc label

frbattid added this to the release/0.11.0 milestone

frbattid self-assigned this

frbattid mentioned this issue

hardening/611_doc_refactoring_as_rtfd #624

Merged

Member Author

frbattid commented Nov 26, 2015

Implemented in PR #624

frbattid closed this as completed

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