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

Improve Specification Readability #92

Closed
AlexDawsonUK opened this issue Apr 17, 2024 · 1 comment
Closed

Improve Specification Readability #92

AlexDawsonUK opened this issue Apr 17, 2024 · 1 comment
Assignees
Labels
technical Corrections, bugs, or minor omissions
Milestone

Comments

@AlexDawsonUK
Copy link
Member

Issue: Currently the specification stands at 313 pages of content. This is incredibly difficult to navigate and has a heavy scroll burden for visitors who want to easily identify what sustainability goals they should be achieving.

Solution: Using a template I created for STAR techniques, and have adapted for the needs of the specification, the main guidelines and success criteria will retain total visibility within the page. However, all remaining content for each guideline will be placed behind a click-to-reveal component of which a visitor can easily show or hide the content when they choose. Allowing for this to take place ensures content only appears when a visitor requires it, and reduces the large body of content upon a cold load to a much reduced size. Details of its final implementation and how successful it has become will follow in due course.

@AlexDawsonUK AlexDawsonUK added the technical Corrections, bugs, or minor omissions label Apr 17, 2024
@AlexDawsonUK AlexDawsonUK added this to the v1.0-D7 milestone Apr 17, 2024
@AlexDawsonUK AlexDawsonUK self-assigned this Apr 17, 2024
AlexDawsonUK added a commit that referenced this issue Apr 18, 2024
@AlexDawsonUK
Copy link
Member Author

The Living Draft now has a functional system in place. Incidentally I've also added a better print stylesheet so that people can print to PDF (or hard copy) the guidelines and success criteria along with the other non-click-to-disclose content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
technical Corrections, bugs, or minor omissions
Projects
None yet
Development

No branches or pull requests

1 participant