Reorganize docs, add several new guides#685
Conversation
garrettjstevens
changed the title
garrettjstevens
changed the title
garrettjstevens
force-pushed
the
admin_and_customization_docs
branch
2 times, most recently
from
ae7004a to
65a6a99
Compare
|
After working with it some more, the above changes to the docs didn't really seem to work. I tried to look at it as if I was new to Apollo and realized the "Administrators" section was unclear since it had so many things. Also, having a separate page for every action in the CLI and GUI docs seemed like it would be hard to create and maintain. After looking over a bunch of other docs sites, I settled on a three main docs sections that seem pretty standard: "Try it out", "Installation", and "Guides", as well as an additional "Developers" section that most projects don't need, but is important for us. Each page in the "Guides" section will have both CLI and GUI instructions for that topic, if applicable, and I think it makes it a lot easier to find information on a certain topic. 
I still think we need a users guide section, but I now think it needs to be a completely separate section from the docs on the website. |
|
I like it based on screenshots - i'd only change i hope i can find some time to look at the content (but now need to get some Zs) |
garrettjstevens
force-pushed
the
admin_and_customization_docs
branch
from
c42253e to
b82f35e
Compare
garrettjstevens
force-pushed
the
admin_and_customization_docs
branch
from
ab62c74 to
08ca5ba
Compare
|
I'm going to merge the guides that are done for now and add/update more in a future PR. |
garrettjstevens
changed the title
* Organize and add more admin docs * Use pngquant on images * More docs restructuring * Add guides section to docs * Work on admin, assembly, and CLI guides * Rename CLI guide directory * Add login instructions to CLI docs * Add docs for adding and removing assemblies * Add doc describing features and how to import them * Add JBrowse configuration docs * Add evidence track docs * Add changelog docs * Improve doc code block theming * Add screenshots/examples to evidence tracks guide * Update theme and coloring docs * Spell and grammar check * Remove guides that aren't finished yet * Run pngquant
2 participants
Draft PR for now since it's still a work in progress, but I wanted to share some screenshots and get feedback while working on it.
Here's what I'm thinking of changing the outline of the docs to:
I'd also like to eventually have a "Users" section with various examples of how to work on different types of annotations.