A simple brainstorming space, powered by the github frontend, a github action, and a simple python script.
For people who don't mind sharing their ideas or their brainstorming process publicly.
Remember: there are no bad ideas in brainstorming.
What it looks like in action: https://github.com/dmarx/bench-warmers
- Fork this repository
- Click on the "Actions" tab and activate github action workflows on your fork.
- Change the name of
README.stub.templatetoREADME.stub
- Select
Add File > Create New Fileto add a new markdown file containing the idea you want to log. Let's call this an "article". - Upon committing, a github action runs which builds the README, which is customizable from a template.
The generated README.md will contain a Table of Contents of your articles, and supports the following features:
- Infers modification date from commit history
- Sort most recently modified ideas at the top
- Hyperlink to document using markdown title as anchor text
- An "estimated idea maturity" metric (it's just character count atm).
- Custom tagging
- Wikipedia-esque "category" pages which group articles by tag
- article filenames contain no whitespace and use the
.mdsuffix - the first line of a markdown article you want added to the README TOC starts with a single 'pound' character (i.e. defines an H1 element for the document title).
- use
lightgreybadges to add a tag to an idea. Yes, this is begging for a simpler approach.
If you don't like these rules, I welcome PRs ;)
It takes a few seconds for the workflow that updates the README to run. Try waiting a few minutes and refreshing the page.
If you get impatient, click on the "Actions" tab and make sure there's an entry associated with your most recent commit with a green check mark next to it. A red X means something went wrong, a yellow circle means the workflow is still running.
Discussion here: https://stackoverflow.com/a/72918091/819544