Skip to content

Rename PURL-SPECIFICATION.rst to md #581#589

Merged
pombredanne merged 78 commits intomainfrom
581-rename-rst-to-md
Aug 13, 2025
Merged

Rename PURL-SPECIFICATION.rst to md #581#589
pombredanne merged 78 commits intomainfrom
581-rename-rst-to-md

Conversation

@pombredanne
Copy link
Member

This PR rename and splits RsT files to Markdown.
It does so conserving the history using a git split approach and careful progressive updates.

I first split each file from the PURL-SPECIFICATION.rst, one at a time. After each individual split, I edited the file to keep only the subset for that file and then committed.

For example:

  • Run: etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/standard/characters-and-encoding.md
  • Then: edit, remove extra text and commit

And repeated this for all files:

etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/standard/characters-and-encoding.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/standard/components.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/standard/references.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/standard/specification-summary.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/known-qualifiers.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/how-to-build.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/how-to-parse.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/tests.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/purl-spec-toc.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst docs/standard/types.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst purl-specification.md
etc/scripts/git-split-file.sh PURL-SPECIFICATION.rst purl-standard.md

Then I run pandoc to convert to markdown, keeping as much line format as possible.

$ for f in `find docs -type f`
> do
> pandoc --wrap=preserve --from=rst --to=markdown --output $f $f
> done
[WARNING] Reference not found for 'permitted characters' at chunk line 1 column 81
[WARNING] Reference not found for 'character encoding' at chunk line 1 column 57
[WARNING] Reference not found for 'case folding' at line 11 column 58

Also at the root:

for f in purl-*.md; do pandoc --wrap=preserve --from=rst --to=markdown --output $f $f; done

Then I reviewed each conversion and amend the pandoc conversion before each commit. I finally aligned this with @johnmhoran text and PR, and merged that on top to get both histories.

…md keep history: create docs/standard/characters-and-encoding.md

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…g.md keep history: keep PURL-SPECIFICATION.rst

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…md keep history: merge

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…md keep history

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Only keep relevant section after split

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…ry: create docs/standard/components.md

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…tory: keep PURL-SPECIFICATION.rst

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…ry: merge

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Only keep relevant section after split

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…ry: create docs/standard/references.md

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…tory: keep PURL-SPECIFICATION.rst

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…ry: merge

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Only keep relevant section after split

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
… keep history: create docs/standard/specification-summary.md

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…md keep history: keep PURL-SPECIFICATION.rst

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
… keep history: merge

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
… keep history

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Only keep relevant section after split

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
… create docs/known-qualifiers.md

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…y: keep PURL-SPECIFICATION.rst

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
… merge

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Only keep relevant section after split

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…ate docs/how-to-build.md

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
…eep PURL-SPECIFICATION.rst

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
pombredanne and others added 19 commits August 13, 2025 17:07
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Fix escaping of dash

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Fix escaping with back slash

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Convert to markdown using pandoc + edits

Reference: #581
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
This matches the tree structure described in #581 with a few extra.
Summary and combined files are generated using pypandoc at
purl-specification.md and purl-standard.md.

Reference: #581
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne pombredanne force-pushed the 581-rename-rst-to-md branch from 9dc2faa to 27bf322 Compare August 13, 2025 17:58
@mjherzog mjherzog changed the title Rename rst files to md #581 Rename PURL-SPECIFICATION.rst to md #581 Aug 13, 2025
Copy link
Member

@johnmhoran johnmhoran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!!

@pombredanne
Copy link
Member Author

There is no content changed here (only new content added for the Ecma/standard part). This should be merged 1st and we can fix it afterwards for typos and more.

Copy link
Member

@mjherzog mjherzog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good for the split.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants