docs: regenerate README and per-type docs#9
Merged
Conversation
docs/akeyless.md was previously truncated mid-file (generated by an old doctool version with a fenced-code-block parsing bug), cutting off before either "Mechanics" sequence diagram. Regenerating with the current doctool restores the full content and also surfaces the Mechanics section directly in README.md, which the tool didn't support until now.
The v4 pipeline's generate-readme step cloned and ran the legacy keyfactor/doctool tool, which was silently reverting every manual docs fix in this PR back to its old (truncated, no Mechanics-in-README) output. v5 runs keyfactor/doctooldotnet from main instead, matching the pattern already in use in certinext-caplugin. Also drops the command_token_url/hostname/api_path inputs and entra/command_client secrets - confirmed unused by v5's starter workflow (not passed to any of its called sub-workflows), and unrelated to this repo's actual integration test secrets, which live in the separate tests.yml workflow. Note: doctooldotnet's Mechanics/README fix is still an open PR (Keyfactor/doctooldotnet#25) as of this commit, so CI will still regenerate docs without that fix until it's merged.
…ip ci] Regenerated locally against the doctooldotnet fix branch (Keyfactor/doctooldotnet#25, not yet merged) so CI's own generate-readme job - which still runs unpatched main - doesn't immediately overwrite this. [skip ci] prevents that job from triggering on this push at all.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/akeyless.mdwas truncated mid-file by an old doctool version (aMarkdownAstbug treated#-prefixed shell comments inside fenced code blocks as headings, cutting the file off before either "Mechanics" sequence diagram). That parsing bug was fixed upstream a while ago, but this repo's docs were never regenerated.Separately, the doctool's PAM renderer never surfaced the
## Mechanics/## Extension Mechanicssection in the top-levelREADME.mdat all — only indocs/akeyless.md. That's fixed upstream too (Keyfactor/doctooldotnet#25), and is included in this regeneration.This PR is just the regenerated output — no docsource content changed, only what doctool renders from it.
What changed
docs/akeyless.md: restored the previously truncated second half of the Mechanics section, including both sequence diagrams.README.md: now includes an#### Extension Mechanicssection per PAM type, with the same diagrams inline.Test plan
dotnet run --project src/Keyfactor.Doctool -- generate-docs --integration-name akeyless-pam --root-repository-path <this repo> --output-dir .)docs/akeyless.mdis no longer truncated and both mermaid diagrams renderREADME.mdnow contains the Extension Mechanics section with no duplicated contentgit diff --statshows onlyREADME.mdanddocs/akeyless.mdchanged