🐛 doc: fix 404 links, dead Run buttons, add examples + FAQ#710
Merged
kris-jusiak merged 3 commits intoJun 2, 2026
Conversation
…er in a new tab - index.md: the Changelog/Tutorial/Examples buttons and the 'Try it online' link pointed at <page>/index.html, which 404 under use_directory_urls:false; point them at the flat CHANGELOG.html/tutorial.html/examples.html (and fix the 'hsttp://' typo). - Remove the broken  buttons from index/tutorial/user_guide; each was already paired with a working 'Run on Compiler Explorer' link, so only the dead button is dropped. - utility.js: open godbolt.org (Compiler Explorer) links in a new browser tab.
…n issues - examples.md: add Eval, Visitor and Dispatch Policy (present in example/ but undocumented), each with a verified Compiler Explorer link. - faq.md: add answers grounded in the user-guide API table and v1.2.0 CHANGELOG for recurring questions (current-state inspection, multi-state checks, event handling/return value, async dispatch via flush_queue, clear_defer, Boost status, Moore vs Mealy).
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
2 participants
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.
Fix broken site content reported on https://boost-ext.github.io/sml/
Follow-up to #709 (which landed the docs-deploy + release automation). These are the on-page fixes; merging will auto-deploy via the
docsworkflow.404 links (
index.md)<page>/index.html, which 404 underuse_directory_urls: false. Repointed to the flatCHANGELOG.html/tutorial.html/examples.html, and fixed thehsttp://typo. Verified against the built tree —examples.html#hello-worldresolves to an existing anchor.Dead "Run" buttons → Compiler Explorer
buttons (39, acrossindex/tutorial/user_guide) — they rendered as a broken placeholder image. Each was already paired with a working ▶ Run on Compiler Explorer link, so only the dead button is dropped.utility.js).New examples
examples.md(present inexample/but undocumented), each with a verified Compiler Explorer link.FAQ — from open issues
Answers grounded in the User Guide API table and the v1.2.0 CHANGELOG:
process_eventreturn/instance (Using event instance with process_event() #487), async dispatch viaflush_queue(Dispatching events in separate thread spawned from action? #583),clear_defer(Access to defer_queue #643), Boost status (When is SML officially part of Boost? #511), Moore vs Mealy (Question: Moore or Mealy state machine? #575).I left a comment on each of those issues pointing at the answer. Drop any FAQ entry you'd rather not keep.
Built locally with MkDocs 1.6 / Python 3.12 — clean; no remaining
/index.html,hsttp://, orCPP(BTN)strings in the output.