Skip to content

Commit 555bdf5

Browse files
authored
Merge pull request package-url#596 from package-url/591-complete-migration-to-docs-files
Regenerate purl-standard.md, add doc-generation.txt package-url#591 This is one replacement file and one new file so low risk to force merge.
2 parents 0a884d2 + 6580e19 commit 555bdf5

File tree

2 files changed

+434
-437
lines changed

2 files changed

+434
-437
lines changed

etc/scripts/doc-generation.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2025-08-13 Wednesday 18:18:27 -- [email protected] -- The current process
2+
for generating (and regenerating as needed) the purl-standard.md and
3+
purl-specification.md files is a combination of manual and scripted steps.
4+
5+
- Start with the set of .md files created from the former PURL-SPECIFICATION.rst
6+
file.
7+
- Update one or more of those .md files as needed in a Visual Studio Code
8+
instance running locally in a branch of a clone of the purl-spec repo.
9+
- Manually copy the full set of .md files to a separate VSCode instance for a
10+
local repo running pypandoc. See, e.g., https://pypi.org/project/pypandoc/.
11+
- Configure the code we've written to choose which compiled .md output we want
12+
(purl-specification.md or purl-standard.md), the input .md files, and any
13+
changes needed for heading names and numbers.
14+
- Run the code, vet the output .md, fix what needs fixing, and manually copy
15+
the output .md back into the local purl-spec VSCode instance.
16+
- After careful vetting etc., commit, push, open a new PR if not already opened,
17+
advise reviewers that the PR is ready for review, and wait for feedback.
18+
- Repeat when needed.
19+
20+
The process is currently run on Windows using WSL2/Ubuntu-20.04.

0 commit comments

Comments
 (0)