[SERVER-45734] Add table of contents to replication architecture guide Created: 23/Jan/20  Updated: 27/Oct/23  Resolved: 16/Aug/21

Status: Closed
Project: Core Server
Component/s: Replication
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: William Schultz (Inactive) Assignee: Backlog - Replication Team
Resolution: Gone away Votes: 0
Labels: former-quick-wins
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Assigned Teams:
Replication
Participants:

 Description   

The replication architecture guide is very thorough and includes a lot of detailed information about various parts of the replication system. When looking for information about a specific subsystem, it would helpful to see a high level overview of the architecture guide structure. A table of contents at the top of the document with links to each section would be helpful.

Ideally, we could generate this automatically, and perhaps integrate it into our build system somehow so that it could be automatically re-generated whenever a change to the architecture guide is made. This is one example of a library that auto-generates a table of contents for markdown files.



 Comments   
Comment by Judah Schvimer [ 16/Aug/21 ]

Github added this feature as shown here, closing as "Gone Away".

Comment by William Schultz (Inactive) [ 23/Jan/20 ]

pavithra.vetriselvan mentioned that she and samy.lanka had discussed this idea previously when working on PM-1474, but there wasn't time to implement it during that project.

Generated at Thu Feb 08 05:09:34 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.