Skip to content

docs(core): rebuild Core docs from .h and remove broken hotdoc config 🔱#15836

Draft
mcdurdin wants to merge 1 commit intochore/core/remove-jsonppfrom
docs/core/rebuild-docs
Draft

docs(core): rebuild Core docs from .h and remove broken hotdoc config 🔱#15836
mcdurdin wants to merge 1 commit intochore/core/remove-jsonppfrom
docs/core/rebuild-docs

Conversation

@mcdurdin
Copy link
Copy Markdown
Member

Rebuild the API docs using api-header-extractor script, and add the script to the normal build for Core so that it doesn't get out of sync again.

Hotdoc configuration has not been used for a while; it is currently broken and we haven't got any docs generated by it anyway, so remove from repo.

Remove largely duplicate BUILDING.md and old json-schema.md.

Test-bot: skip

@keymanapp-test-bot
Copy link
Copy Markdown

keymanapp-test-bot bot commented Apr 10, 2026

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

  • Developer
    • Keyman Developer - build : all tests passed (no artifacts on BuildLevel "build")
    • Compiler Regression Tests - build : all tests passed (no artifacts on BuildLevel "build")
    • Keyman Developer (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
    • kmcomp.zip - build : all tests passed (no artifacts on BuildLevel "build")
    • kmcomp.zip (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
  • Keyboards
    • Test Keyboards - build : all tests passed (no artifacts on BuildLevel "build")
  • macOS
    • Keyman for macOS - build : all tests passed (no artifacts on BuildLevel "build")
    • Keyman for macOS (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
  • Web
    • KeymanWeb Test Home - build : all tests passed (no artifacts on BuildLevel "build")
  • Windows
    • Keyman for Windows - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for Windows - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for Windows (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
    • Keyman for Windows (old PRs) - build : all tests passed (no artifacts on BuildLevel "build")
    • Text Editor (ARM64) - build : all tests passed (no artifacts on BuildLevel "build")
    • Text Editor (x64) - build : all tests passed (no artifacts on BuildLevel "build")
    • Text Editor (x86) - build : all tests passed (no artifacts on BuildLevel "build")

@keymanapp-test-bot keymanapp-test-bot bot changed the title docs(core): rebuild Core docs from .h and remove broken hotdoc config docs(core): rebuild Core docs from .h and remove broken hotdoc config 🔱 Apr 10, 2026
@keymanapp-test-bot keymanapp-test-bot bot added this to the A19S26 milestone Apr 10, 2026
@github-actions github-actions bot added core/ Keyman Core docs labels Apr 10, 2026
@mcdurdin mcdurdin force-pushed the chore/core/remove-jsonpp branch from f19e695 to 35e09ca Compare April 11, 2026 05:40
Rebuild the API docs using api-header-extractor script, and add the
script to the normal build for Core so that it doesn't get out of sync
again.

Hotdoc configuration has not been used for a while; it is currently
broken and we haven't got any docs generated by it anyway, so remove
from repo.

Remove largely duplicate BUILDING.md and old json-schema.md.

Test-bot: skip
@mcdurdin mcdurdin force-pushed the docs/core/rebuild-docs branch from 09a0261 to 8b88195 Compare April 11, 2026 15:33
@github-actions github-actions bot added docs and removed docs labels Apr 11, 2026
@keyman-server keyman-server modified the milestones: A19S26, A19S27 Apr 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants