Skip to content

docs: the front door leads with the recorded session and states what works where - #48

Merged
suboss87 merged 1 commit into
Mainfrom
devin/1787803597-readme-refresh
Aug 27, 2026
Merged

docs: the front door leads with the recorded session and states what works where#48
suboss87 merged 1 commit into
Mainfrom
devin/1787803597-readme-refresh

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Summary

The README asked a reader to take three paragraphs of positioning on trust before showing them anything the tool does, and the one artifact that cannot be faked — the recorded session — was a click away in docs/USAGE.md. This reorders the front door around evidence and adds the one section it was missing.

  • ## A real session is now the second thing on the page, embedding media/session.gif with the media/record-session.sh link next to it, plus npx fdeops demo as the zero-install path. The recording gate accepts README or USAGE as the host; it now reports recorded session in README.md + docs/USAGE.md.
  • ### What works where replaces the per-row "Claude Code does X, others do Y" caveat that was repeated in four places. Two columns, four rows, and the one honest admission the README never made in a table: pulling from Granola/Slack/Notion requires you to add that source MCP — FDEOps only ingests.
  • "It is working if" is now an explicit acceptance check under Quickstart, not an inference from a paragraph: npx fdeops resume prints phase, trust, next action — and prints the same thing tomorrow from a cold session.
  • Engagement memory states the day-one guarantee shipped in fix: a day-1 fieldbook shows no invented rows, and template prose stops passing for evidence #47: the fieldbook arrives with headings and allowed values and no invented rows, so anything you read in it happened.
  • Trimmed the copy-cat-adjacent defensiveness ("resemblance is craft, not a fork") from the credits, and the "Memory + methodology + skills, in one kit" line that named the parts instead of the job.

One drive-by: adapters/README.md linked ../README.md#switch-coding-agents-anytime, an anchor that has not existed for some time; it now points at #what-works-where, which covers the same question.

No code, no skills, no templates. npm run check green, 110/110.

Link to Devin session: https://app.devin.ai/sessions/f135381c4682413bae73dff38eb6d1a3
Requested by: @suboss87


Devin Review

…works where

Co-Authored-By: Subash Natarajan <suboss87@gmail.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@suboss87
suboss87 merged commit 4f04fee into Main Aug 27, 2026
2 checks 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.

1 participant