NRLMMD-GEOIPS / NRLMMD-GEOIPS/pluginify

Duplicate links to sections in docs

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

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Requested Update

Description

The syntax we are using to produce stable links to sections in our docs is cumbersome. We're currently doing this in many locations:

(pluginify_create)=

## pluginify create

{ref}`pluginify create <pluginify_create>`

What this does:

  • (pluginify_create)= creates a stable anchor to this location whose URL won't change, even if the heading title changes.
  • pluginify create creates a heading which also implicitly creates an anchor. However, if this heading were to change, the anchor and URL would change, breaking any existing references.

  • {ref}pluginify create <pluginify_create> creates a link whose text reads "pluginify create" directly below the heading. This allows easily sharing the stable link but is ugly.

The result would look like this:

pluginify create

pluginify create

where the first line would also have a link symbol next to it, pointing to the unstable header reference and the second line is a link back to the (pluginify_create)= anchor.

It would be nice to update our docs such that the link symbol points back to the stable reference rather than an unstable link.

Recommended practice is to use:

## pluginify delete```

This creates one, link, but if the heading were updated to not match the anchor, would create two links. The anchor is stable while the heading is not. Unfortunately, that means that, if someone provides the URL provided by the link symbol, they are providing the unstable link.

Other options are to require that all headings use explicit syntax like this:

```(pluginify_delete)=
## pluginify delete {#pluginify_delete}```

Or edit the theme template to automatically use the explicit link if it exists.

### Checklist for Completion
* [ ] <!--- Include a list of steps that must be complete in order to close this Issue --->

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

Start by reviewing the repeated anchor and reference patterns in the documentation, then inspect the theme template that generates the heading link symbol. Compare the proposed explicit-anchor and template approaches, and confirm that the chosen approach produces a single stable link for each documented section without duplicate links.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.