-
Notifications
You must be signed in to change notification settings - Fork 235
Statically generate anchor tags in model documentation #1681
Description
User Story
Following the work of #1373 it was discovered that the dynamic insertion of anchor tags degraded the performance of larger pages (such as the complete documentation for models), contributing to a frustrating "time to interactive" of over 12 seconds.
When a page loads, a script runs that crawls the site for header tags, and inserts anchors besides each header. This is useful for collaboration as it allows users to pass links to others that refer to specific sections of the site, but there is no need to do this dynamically when we already have a static model generation pipeline doing a lot of the heavy lifting.
As a consumer of model documentation, I would like the documentation to utilize static generation wherever possible so that the pages are usable as the complexity of the models increase.
Goals
- Discover (or create) a mechanism to toggle the dynamic anchor insertion script.
- Measure the performance gain (specifically the "time to interactive" metric) when dynamic anchor insertion is disabled.
- Adjust the model documentation pipeline to generate anchors statically.
Dependencies
Created off of guidance in #1373.
Acceptance Criteria
- All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
- A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
- The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status