getodk / getodk/docs

Flesh out and document changeref script

Open
#400 0 comments 0 reactions 0 assignees View on GitHub
coding python
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

Now that things have settled down, two useful additions could be made to changeref.py:

- redirects in s3_website.yml
- change names in tables of content

These would only be done for doc refs, not section refs

Contributor guide

Open the contributing guide

Research direction

Start by reading changeref.py and s3_website.yml to understand how document references are currently changed. Trace how document references differ from section references, then implement support for redirects and table-of-content change names only for doc refs. Done means both additions work without affecting section refs.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.