-
Notifications
You must be signed in to change notification settings - Fork 0
Add navigation map diagrams for TPEN ecosystem interfaces #64
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: cubap <1119165+cubap@users.noreply.github.com>
|
@copilot what models did you use for this? |
I analyzed the existing repository structure to create the navigation map: Information Sources:
I synthesized these into the comprehensive navigation map by:
The diagram structure follows the same mermaid syntax and styling patterns already used in the existing workflow diagrams on the page. |
|
|
||
| This diagram shows how the documentation site (t-pen.org) and the application interfaces (app.t-pen.org) interlink, providing a complete navigation overview of the TPEN ecosystem. | ||
|
|
||
| ```mermaid |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This graph is very hard to read. Can the busy nodes break out and have their discrete graphs so the nodes are larger on screen and easier to read? Also if there is a very peripheral set of interfaces they can be clustered into a grouped set.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Refactored in commit e8e47aa.
The single complex diagram has been split into 6 focused diagrams:
- System Overview (4 nodes) - High-level component view
- User Entry & Authentication (8 nodes) - Onboarding flow
- Application Dashboard (7 nodes) - Main navigation
- Project Management (6 nodes) - Leader workflow
- Core Transcription (5 nodes) - Primary task flow
- External Integrations (8 nodes) - Data flow
Key improvements:
- Nodes are now 3-4x larger and easier to read
- Peripheral interfaces grouped into clusters ("Documentation Resources", "User Settings", "Advanced Settings")
- Progressive organization from high-level overview to specific workflows
- Each diagram is self-contained and focused on one aspect
The diagrams use consistent color-coding across all sections for easy recognition.
Co-authored-by: cubap <1119165+cubap@users.noreply.github.com>
Adds mermaid diagrams documenting how the documentation site (t-pen.org) and application interfaces (app.t-pen.org) interlink, including authentication flow and external service integrations.
Changes
core-workflow-mermaid.md: Added "TPEN Navigation Map" section at top of workflow page_layouts/default.html: Added "Workflow" link to navigation menu (both homepage and internal page layouts) for discoverabilityDiagram Structure
The navigation map consists of 6 focused diagrams:
Peripheral interfaces are grouped into clusters:
Leverages existing Mermaid.js configuration in the Jekyll site layout.
Result
Navigation map available at
/workflow- accessible from main menu and provides clear, focused visual overview of interface relationships across the TPEN platform with improved readability and progressive disclosure from overview to details.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.