Fix broken links and create dedicated core concept pages #254
Conversation
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
|
- Fix broken links: - Update Footer GitHub link from generic to project-specific - Change Footer "API Reference" label to "Documentation" - Fix all /docs/createMachine/ links to /docs/createmachine/ (lowercase) - Remove broken robot/debug link reference - Ensure all doc links have trailing slashes - Create dedicated core concept pages: - Add concepts-state.md - Understanding State in FSMs - Add concepts-transitions.md - Understanding Transitions - Add concepts-events.md - Understanding Events - Add concepts-guards.md - Understanding Guards - Add concepts-actions.md - Understanding Actions - Update core-concepts.md to serve as overview page with links to detailed concept pages - Update DocsSidebar to link to new individual concept pages instead of hash sections Fixes #249
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Fixes broken links throughout the docs site and creates dedicated pages for each core FSM concept, addressing all issues reported in #249.
Changes
Fixed Broken Links
https://github.com→https://github.com/matthewp/robot)/docs/createMachine/links to/docs/createmachine/(lowercase to match build output)robot/debuglink reference from main pageCreated Dedicated Core Concept Pages
Previously, all core concepts were hash sections on one page. Now each has its own dedicated page focused on FSM theory and patterns:
/docs/concepts-state/- Understanding State in FSMs/docs/concepts-transitions/- Understanding Transitions/docs/concepts-events/- Understanding Events/docs/concepts-guards/- Understanding Guards/docs/concepts-actions/- Understanding ActionsUpdated Existing Pages
core-concepts.mdto serve as overview page with links to detailed concept pagesWhy These Changes?
The concept pages are now distinct from API reference pages:
concepts-*.md): Educational content about FSM theory, patterns, and best practicesstate.md,transition.md, etc.): Technical reference for Robot's specific implementationThis separation makes it easier for users to learn FSM concepts vs looking up API syntax.
Fixes #249