Skip to content

docs: rewrite the home page and guides, consolidate the docs - #114

Merged
Deityhub merged 5 commits into
devfrom
docs/home-and-guides
Nov 16, 2026
Merged

Deityhub merged 5 commits into
devfrom
docs/home-and-guides

Conversation

@Deityhub

Copy link
Copy Markdown
Owner

What

  • Home page rewritten around write, check, collaborate, review and publish.
  • Guides keep their slug, title, description and published/updated moments in front matter; the index leads with the latest guide; three new guides (review, GitHub, writing together).
  • Docs consolidated: product spec folded into the system spec; architecture, features roadmap, routes README and roadmap.md removed; README, UI spec, design system, infra README and AGENTS updated.
  • public/llms.txt is generated from the site copy (bun run llms) with a drift test.
  • Screenshot script fixed and all screenshots retaken, plus four new ones.

Checks

Unit tests, lint, typecheck, tailwind:check and licenses pass. The full e2e suite was not re-run after the docs commit.

…tter

- slug, title, description, order, published and updated live in content/guides/<slug>.md,
  read at build time, so a new guide needs no code change
- published and updated are UTC moments; the page shows the time when both fall on one day
- site constants move to a plain module so the e2e runner can read them
…eview and publish

- new hero with a real editor screenshot, the live checker second, a five-step flow with the
  real limits, three principles, a combined "Also in the box" and "Who it's for", a two-column
  FAQ of nine questions
- site description, feature list and llms.txt follow the new copy; the SEO claims test now
  reflects that editing together, review and GitHub publishing are built
… together, redesign the index

- drop dev.to and Hashnode for blogging platforms in general; the guide is now
  markdown-for-blogging-platforms with a test-post checklist instead of per-platform claims
- fix profile names, remove the repeated product paragraph, and tailor each closing
- new guides: share for review, publish to GitHub, write together online or offline
- published and updated carry realistic UTC times, shown on the guide page; the catalogue
  carries each guide's reading time
- the index leads with the newest guide in a featured card, then lists the rest one per row
  with publish date and reading time
…tter, relative guide links

- Privacy and terms: editing together, the live connection, changing the email address,
  on-device search; updated date
- Privacy and terms carry their own front matter (read like the guides'), and the page shows
  "Last updated" with its time
- Guides link to the editor and each other by path, so local and preview builds stay on themselves
- Updated existing UI screenshots to reflect recent changes in the application.
- Added new screenshots for settings AI, search palette, guides index, and admin dashboard.
- Enhanced README documentation to include new features such as accounts, sync, uploads, sharing, GitHub publishing, and real-time collaboration.
- Introduced a new script to generate the llms.txt file from the site's content.
- Improved the AI writing actions and added tests to ensure consistency.
- Removed the outdated roadmap.md file and cleaned up the routes documentation.
@github-actions

github-actions Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

The preview for this pull request was removed.

@Deityhub
Deityhub merged commit bada968 into dev Nov 16, 2026
5 checks passed
@Deityhub
Deityhub deleted the docs/home-and-guides branch November 16, 2026 16:09

This branch was successfully deployed

1 active deployment
preview — 4570265a Deployed Nov 16, 2026 by Deityhub via Deploy preview #181
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.

1 participant