refactor: major README overhaul — branding, formatting, new tools, comparison table#63
Merged
Conversation
- Rewrite contributing.md with entry format guide, icon reference table, checklist for new entries, and category descriptions - Update PR template with description section and submission checklist - Add GitHub issue templates for tool suggestions and issue reports - Add weekly dead link checker workflow using lychee-action
- Add docs/evaluation/ with 30-parameter evaluation system - Include LLM evaluator prompt for batch project assessment - Include current project list (pipe-delimited) for evaluation input - Add TODO-manual-steps.md for GitHub repo metadata updates
…icates
- Convert legend to table format with new icons (iOS, E2EE, archived)
- Add license (SPDX) and tech stack tags to all open-source entries
- Add new icons to all entries based on per-project research:
- iOS (🍎): AppFlowy, GitJournal, DailyVox, Joplin, Standard Notes,
Logseq, SiYuan, AnyType, Char, Notesnook, Obsidian, Inkdrop, and more
- E2EE (🔒): Standard Notes, AnyType, Joplin, Notesnook, Obsidian Sync,
Inkdrop, Reflect
- Archived (⚠️ ): Tomboy, Org-brain, Notable, CodiMD, Laverna, Neuron,
Wridea, Polar, OktoNote
- Add 6 missing open-source Web UI tools:
Outline, Memos, HedgeDoc, Flatnotes, Docmost, Notesnook
- Add 9 missing proprietary tools:
Notion, Craft, Bear, Capacities, Heptabase, Tana, Reflect, Mem, Ulysses
- Remove duplicate AppFlowy from Electron section
- Fix typo "Zim Deskop Wiki" -> "Zim Desktop Wiki"
- Fix contradictory icons on Supernotes and MindMirror
- Fix "Emanate" -> "Emanote", fix "Succesor" -> "Successor"
- Fix JournalCalls incorrect Android icon (phone service, no native app)
- Remove "Archived" text from Standard Notes description
- Add missing dash before Fossil and Org-mode descriptions
- Replace plain title with centered div containing logo, tagline, and badge row - Badges: awesome, stars, last-commit, contributors, project count (100+) - Add welcoming intro paragraph explaining the list and CTA to contribute
- Table covers top tools with Storage, Sync, E2EE, Platforms, Plugins, Price - Placed before Contributing section for easy discovery
- All list markers were already dash (written consistently in content commit) - Sort Editor Plugin top-level: Emacs, vim-wiki, Visual Studio Code - Sort Emacs sub-entries: Deft, howm, Hyperbole, Org-brain, Org-mode, Org-roam - Sort VS Code sub-entries: Emanote, Foam - Fix Proprietary: Notebook, NotePlan, Notion (correct alphabetical order)
- Add TUI, Quick Comparison, Contributing to table of contents - Add .markdownlint.yml disabling MD013/MD033/MD041 for awesome-list format - Regenerate docs/evaluation/projects.txt from updated README (100 projects)
The previous media/logo.svg was a copy of the awesome-nodejs logo with path-encoded text reading "node.js" and "curating the best Node.js modules and resources". Replace with a clean SVG using <text> elements showing a notepad+pencil icon, "awesome note-taking", and an appropriate tagline. Keeps the same #494368/#699D68 palette.
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
1 participant
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
This PR implements the full refactoring plan from
plan.mdacross 4 execution waves and 8 commits.Phase 1 — Header & Branding
<div>block: logo, tagline, and badge row (awesome, stars, last-commit, contributors, project count)Phase 2 — Legend & Formatting
-Phase 3 — Content Improvements
LICENSEandTech/Languagetags to all ~65 open-source entriesPhase 4 — GitHub Repository Improvements
contributing.mdwith entry format guide, icon reference table, checklist, and category descriptionssuggest-tool.ymlandreport-issue.ymlPhase 5 — Evaluation Framework
docs/evaluation/with 30-parameter evaluation system, LLM evaluator prompt, and current project listPhase 6 — Manual Steps
TODO-manual-steps.mddocumenting repo description update, topic additions, and profile pinPhase 7 — Validation
.markdownlint.ymlsuppressing rules incompatible with awesome-list formatdocs/evaluation/projects.txtfrom updated README (100 projects)Test plan
#contents