Skip to content
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

Meta: GitHub-sourced Mindmap #1559

Merged
merged 1 commit into from
Jul 3, 2024
Merged

Meta: GitHub-sourced Mindmap #1559

merged 1 commit into from
Jul 3, 2024

Conversation

adamziel
Copy link
Collaborator

@adamziel adamziel commented Jul 1, 2024

Motivation for the change, related issues

Renders a mindmap of linked projects from GitHub issues to make connections and dependencies visible. The project grew so much, I couldn't process the incoming work in my head anymore. This is a v1 of a tool I hope to use to:

  • Quickly figure out is any particular new issue relevant in the short term
  • Communicate why a specific project matters
  • Track the progress we're making towards larger goals – they will become more apparent as this mindmap grows

CleanShot 2024-07-01 at 21 31 00@2x

Future work

  • CI-generated public HTML page
  • A more reliable way to connect two issues
  • A basic UI to connect another node directly from the app
  • Server side rendering to easily include highlighted mindmap fragments in issues descriptions

Implementation details

  • Downloads the list of issues from Playground-related repositories using GitHub's GraphQL API
  • Connects any two issues/prs with [Type] Mindmap Node label
  • Connects all issues mentioned in issues/prs with label [Type] Mindmap Tree
  • Starts at the Roadmap issue
  • Uses D3.js to render an interactive mindmap with clickable links

Testing Instructions (or ideally a Blueprint)

Run:

npm run mindmap

And go to http://127.0.0.1:5269/

cc @bgrgicak @brandonpayton

@adamziel adamziel requested a review from a team as a code owner July 1, 2024 19:37
@adamziel adamziel self-assigned this Jul 1, 2024
@adamziel
Copy link
Collaborator Author

adamziel commented Jul 3, 2024

I need this to think so I'll go ahead and merge. A publicly rendered link etc will come later

@adamziel adamziel merged commit c5f97ce into trunk Jul 3, 2024
5 checks passed
@adamziel adamziel deleted the project-mindmap branch July 3, 2024 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant