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

Small improvements to help with user-friendliness #28

Open
1 of 4 tasks
timvdstap opened this issue Nov 28, 2023 · 1 comment
Open
1 of 4 tasks

Small improvements to help with user-friendliness #28

timvdstap opened this issue Nov 28, 2023 · 1 comment
Assignees
Labels
easy fix typo or broken link, something that should take < 10 min to revise

Comments

@timvdstap
Copy link
Collaborator

timvdstap commented Nov 28, 2023

Few suggestions:

  • In the sections Provide Context and Understandability to your data and Make your data software ready, I think we should consider numbering the subsections (i.e. 1. Use non-proprietary formats) just to make it more user (or reader) friendly.
  • Additionally, perhaps we should consider not capitalizing the sections
  • Consider changing name of the repository to 'bds-primer-guidelines'
  • Possible to have the table of contents appear under subsection headings on the left hand of the page?
@timvdstap timvdstap added the easy fix typo or broken link, something that should take < 10 min to revise label Nov 28, 2023
@sformel-usgs
Copy link
Collaborator

@timvdstap let me know what you think...

  1. The section numbering is trickier. I was able to add numbering in, but it also must exist for the individual chapters: https://quarto.org/docs/reference/formats/html.html#numbering This is a problem because the chapters are numbered based on their order in the yml. As we populate more chapters, the numbering would change. It won't break links, but might cause confusion.
  2. The capitalization is done.
  3. The repo renaming is important but I'm not sure how to do all the parts yet. Maybe we can file this as a medium-sized goal to address in a 'sprint' where a few of us work on it together over the course of one day? It seems we can do redirects and I think forks will be ok but I would feel most comfortable tackling this with a team of testers.
  4. The TOC is different from the chapter listing on the left. I removed the TOC for now. See: Can the TOC be integrated in the sidebar contents? quarto-dev/quarto-cli#5859 Important to know that each requires different structures to expose subsections.

@sformel-usgs sformel-usgs self-assigned this Mar 13, 2024
sformel-usgs added a commit to sformel-usgs/bds-primer-best-practices that referenced this issue Mar 13, 2024
sformel-usgs added a commit that referenced this issue Mar 13, 2024
minor revisions related to issue #28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy fix typo or broken link, something that should take < 10 min to revise
Projects
None yet
Development

No branches or pull requests

2 participants