Use case pages: add a How It Works section - #5498
Draft
dimitrieh wants to merge 1 commit into
Draft
Conversation
Use case pages carried only what and why. This adds a howItWorks block to the layout covering the component breakdown, the design pattern chosen, an end-to-end architecture diagram and the hand-off into the product docs. Filled in for production monitoring and shop floor communication, with placehold.co stand-ins until the real diagrams are drawn. Two supporting fixes: section eyebrow numbers now derive from the nav array instead of being hardcoded, so they no longer drift when a page omits a block; and the architecture front-matter key on shop floor communication, which the layout never read, now renders as a link to the architecture page the use case sits on.
Contributor
Author
✅ Deploy Preview for flowforge-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
I like the direction but you need to break down the problem like this: https://docs.google.com/drawings/d/1u2xDF5igAhPMYzAmBxOY4eRKJvdKuY7MoGWbPPUIUUU/edit production monitoring consists of a software app and a hardware app Main point: Use case does not = 1 app |
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.
Description
Use case pages carried only what and why. This adds a
howItWorksblock to the use case layout so a page can also show how FlowFuse builds the thing: the component breakdown, the design pattern chosen, an end-to-end architecture diagram, and the hand-off into the product docs.Filled in for the two use case pages, Production Monitoring and Shop Floor Communication. Diagrams are
placehold.costand-ins pending an art request; the layout renders a dashed border and a "Placeholder diagram" caption whilediagram.placeholderis set.Two supporting fixes:
loop.index, so they desynced on any page omitting a block. Both now derive from one lookup over the nav array.architecture: "edge-connectivity"on Shop Floor Communication was front-matter the layout never read. It now sits insidehowItWorksand renders as a link to the architecture page the use case sits on.Content note for review: the design pattern assigned to each page is a first pass and needs a sales sign-off. Per-pattern docs pages do not exist yet, so
docsUrlpoints at the nearest real pages (/docs/user/devops-pipelines/,/docs/user/envvar/) rather than at pattern docs.Related Issue(s)
None.
Checklist