KhronosGroup / KhronosGroup/KSCAF_DocGuidelines

Layout ongoing: Add hyper links between guideline chapters

Open
#27 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Some chapters (subject items) are related to other items in the document and so it would be useful to have hyper-links between relevant chapters to aid the reader

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the guideline chapters and identify subject items that are related to one another. Add hyperlinks between the relevant chapters, then check the document navigation to confirm the links point to the intended sections.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.