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

(Editorial) Use a three level deep TOC in the VCDM spec #1306

Closed
iherman opened this issue Oct 6, 2023 · 2 comments
Closed

(Editorial) Use a three level deep TOC in the VCDM spec #1306

iherman opened this issue Oct 6, 2023 · 2 comments
Assignees
Labels

Comments

@iherman
Copy link
Member

iherman commented Oct 6, 2023

At the moment, the TOC setting in the document stops at two levels (i.e., §A or §A.B). I would propose to add a third level (ie, §A.B.C). Our spec is complex, and many important sections are on that level (e.g., the ones discussed in PRs like #1302) and it makes it very difficult to read the spec. I realize the TOC becomes fairly complex: so be it...

@msporny
Copy link
Member

msporny commented Feb 7, 2024

I have implemented a 3-level deep TOC in add0ade.

@msporny msporny closed this as completed Feb 7, 2024
@iherman
Copy link
Member Author

iherman commented Feb 7, 2024

The issue was discussed in a meeting on 2024-02-07

  • no resolutions were taken
View the transcript

4.1. (Editorial) Use a three level deep TOC in the VCDM spec (issue vc-data-model#1306)

See github issue vc-data-model#1306.

Brent Zundel: Right now we have 2 levels in the TOC and ivan is recommending 3. How do folks feel?

Manu Sporny: I dont like the three levels. It makes the TOC messy.

Ivan Herman: I have major difficulties finding stuff in this spec.

Ted Thibodeau Jr.: If we have a 2 level TOC we should make the document two levels deep. unless we add an index.

Brent Zundel: is anyone willing to do this work?

Manu Sporny: I can do the work. I am trying to see how sad it makes me. You can assign it to me.

Brent Zundel: with your statement we don't have consensus.

Ted Thibodeau Jr.: pretty sure the work require is changing a line in the HTML source.

Brent Zundel: Ted are you volunteering.

Manu Sporny: Already done this. They have updated respec to make the TOC items smaller. I'm ok with this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants