docs: add Doxygen API reference and fix wiki/README gaps #2
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
| name: Documentation Sync Check | |
| on: | |
| pull_request: | |
| branches: [main] | |
| types: [opened, synchronize] | |
| paths: | |
| - 'imgui-platform-kit/include/**' | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| jobs: | |
| doc-sync: | |
| runs-on: ubuntu-latest | |
| if: github.event.pull_request.head.repo.full_name == github.repository | |
| steps: | |
| - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4 | |
| with: | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - name: Check documentation completeness with Gemini | |
| uses: google-github-actions/run-gemini-cli@055c24c9f565debe282e4adf1f7ca1715040ebe2 # v0 (2026-06-19) | |
| with: | |
| gemini_cli_version: latest | |
| gemini_api_key: ${{ secrets.GEMINI_API_KEY }} | |
| prompt: | | |
| This pull request modifies one or more public API headers under | |
| `imgui-platform-kit/include/`. Audit the documentation impact and post a | |
| single PR comment listing what needs updating. Do NOT commit or modify any files. | |
| Repository: ${{ github.repository }} | |
| PR number: ${{ github.event.pull_request.number }} | |
| Project layout: | |
| - Public headers: imgui-platform-kit/include/**/*.h | |
| - README: README.md (top-level) | |
| - Changelog: CHANGELOG.md (top-level) | |
| Documentation convention: every public class, struct, and function in include/ | |
| should have a Doxygen block with at minimum @brief, one @param per parameter, | |
| and @return (unless void). | |
| Steps: | |
| 1. Run: gh pr diff ${{ github.event.pull_request.number }} | |
| to see the changed files and lines. | |
| 2. For each changed header file, check: | |
| a) Doxygen — new public functions/methods: does each have a complete block? | |
| Existing functions with changed signatures: is the Doxygen still accurate? | |
| List each issue as: include/path/file.h — FunctionName: what is missing. | |
| b) README — scan README.md for code snippets using the changed API. List any | |
| snippets that may need updating with an approximate line reference. | |
| c) CHANGELOG — if the API change is notable (new feature, behaviour change, | |
| parameter rename), flag that CHANGELOG.md may need an entry under [Unreleased]. | |
| 3. Post the findings as a PR comment: | |
| gh pr comment ${{ github.event.pull_request.number }} --body "..." | |
| Use this structure in the comment body: | |
| ## Documentation sync check | |
| ### Doxygen | |
| - [ ] include/path/file.h — FunctionName: missing @param x | |
| ### README | |
| - [ ] Line ~42: snippet uses old constructor signature | |
| ### CHANGELOG | |
| - [ ] Consider adding entry under [Unreleased] for the UserInterface API change | |
| Write "No issues found." under any heading with nothing to report. | |
| One line per item. Do not suggest replacement wording — only identify what needs attention. | |
| env: | |
| GEMINI_CLI_TRUST_WORKSPACE: 'true' | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |