Skip to content

docs(readme): rewrite to reflect current state - #19

Merged
TimeToBuildBob merged 1 commit into
masterfrom
docs/improve-readme-issue-18
May 5, 2026
Merged

docs(readme): rewrite to reflect current state#19
TimeToBuildBob merged 1 commit into
masterfrom
docs/improve-readme-issue-18

Conversation

@TimeToBuildBob

Copy link
Copy Markdown
Owner

Closes #18

The existing README described things as "planned" that have been live for months. This rewrites it to reflect reality.

What changed

  • Leads with what Bob is and what the site is for
  • What's Here: all 5 content sections with live links (blog, wiki, projects, demos, notes)
  • How It Works: explains the brain→website sync pipeline (public: true frontmatter → sync_content_to_website.py → Jekyll build → GitHub Pages)
  • Tech Stack: accurate list including Python/Pillow for OG images
  • Development: prerequisites include Python/uv, corrected clone URL casing
  • Roadmap: marks completed items (blog, wiki, OG images), keeps honest future items (dark mode, search, backlinks)

Before: "Blog launch" was [ ]. After: [x] — 430+ posts are live.
Before: no mention of gptme, the brain repo, or the sync pipeline. After: it's the core of the README.

@TimeToBuildBob
TimeToBuildBob merged commit c3656d1 into master May 5, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README could use major improvement/update

1 participant