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

Documentation Improvement - use indents #299

Open
Jegelewicz opened this issue Aug 9, 2023 · 0 comments
Open

Documentation Improvement - use indents #299

Jegelewicz opened this issue Aug 9, 2023 · 0 comments
Labels
enhancement This would make documentation better

Comments

@Jegelewicz
Copy link
Member

From an incoming collection who was asked to follow the instructions in How To Manage a Collection

The only other (nitpicky) thing I might suggest is whether it's possible to indent the sections? I know that "How to Manage a Collection", "Arctos Community Data", and "GUID Prefix", for instance, are all at different font size, but it might be easier for folks to follow along if "GUID Prefix", "Collection Type", etc. were indented below "Arctos Community Data". However, this is also a style choice for all the Arctos wikis/handbooks, so maybe not something you want to mess with. And as I say, this is just a change that would help people like me who are too lazy to read all the detail and just skim things and then miss sections--people should really just read the whole document and follow along!

My response

Thanks for the feedback!

I hear you on the indents. I have thought about this and there are a few places where someone has tried to do it, but markdown doesn't really support it and that means it requires knowledge of css and html - which can be a barrier if we want everyone to be able to edit the handbook (not that everyone does - but we are ever-hopeful....)

The section headers are headers though, and on the left side of the page you can see a kind of index that expands as you move through the documents. These headers are indented - but I'm not sure that people notice or pay attention to that side panel.

Long documents are definitely difficult to read and the headers are difficult to distinguish between #, ##, and ###.

Can we add indentations in some way that makes it easy for inexperienced editors to manage?

@Jegelewicz Jegelewicz added the enhancement This would make documentation better label Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This would make documentation better
Projects
None yet
Development

No branches or pull requests

1 participant