Skip to content

Comments

Revamp document generation ecosystem#129

Merged
PingDavidR merged 27 commits intomainfrom
CDI-611-docgen
Oct 1, 2025
Merged

Revamp document generation ecosystem#129
PingDavidR merged 27 commits intomainfrom
CDI-611-docgen

Conversation

@PingDavidR
Copy link
Contributor

  • CDI-611
  • Create a standalone tools module for documentation generation
  • Removed documentation creation process from the testing framework
  • Generated documentation added to the repository under docs folder as reference
  • Modify asciidoc templating and output to align with the Developer Portal standards of the existing documents
  • added golden tests to ensure no future inadvertent drift in the documentation
  • created a small utility to search for duplicate functions; currently only checking the tools folder, but can be expanded through configuration
  • READMEs for generating documentation, updating portal documentation
  • tweaked repo README for markdown linting issues

@PingDavidR PingDavidR requested a review from a team as a code owner September 18, 2025 15:26
@erikostien-pingidentity
Copy link
Contributor

Do we want to link generated docs to the current version of pingcli at all?

@PingDavidR
Copy link
Contributor Author

Do we want to link generated docs to the current version of pingcli at all?

That is a separate conversation taking place right now, and is dependent on how the portal hosting is configured, what options are available, how we can pull that off. I'll track that separately as well.

@PingDavidR PingDavidR merged commit 63df2c8 into main Oct 1, 2025
10 checks passed
@PingDavidR PingDavidR deleted the CDI-611-docgen branch October 1, 2025 14:18
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.

2 participants