RunestoneInteractive / RunestoneInteractive/java4python

all chapter and section xml:id references should mimic the title in all lowercase and with "-" replacing spaces

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

Nobody has claimed this yet.

Dominant language
Python
Stars
28
Forks
42
PR merge metrics
No merged PRs in 30d

Description

writing xml:id tags to only "sort of"mimic the title will make for very difficult referencing and update.

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 locating the chapter and section XML sources and reviewing their xml:id values alongside the corresponding titles. Update the references so each identifier uses the lowercase title with spaces replaced by hyphens, then verify that all chapter and section identifiers follow the same convention.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.