Skip to content

Add docs-as-code / developer-experience demo for the technical writing job function - #171

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1785182962-docs-as-code-devex-demo
Open

Add docs-as-code / developer-experience demo for the technical writing job function#171
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1785182962-docs-as-code-devex-demo

Conversation

@devin-ai-integration

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

Copy link
Copy Markdown
Contributor

Summary

demos/ previously covered four job functions (data engineering, security, migration, application development). This adds the technical-writing / DevEx thread: demos/technical-documentation/docs-as-code-and-devex-demo.md, a single linear demo on the otterworks polyglot monorepo.

The narrative hangs on real, verified drift on main rather than invented examples — this is what makes the thread demo-able without staging anything:

  • docs/api-route-matrix.md states the gateway "currently has no /api/v1/templates prefix in ServiceRoutes", that /api/v1/folders is not routed, and that reports are not routed — while Config.ServiceRoutes() in services/api-gateway/internal/config/config.go maps all three today.
  • ARCHITECTURE.md § 11 documents the web frontend at frontend/web-app/; the directory on main is frontend/client-app/.
  • README.md's Services table lists 11 backend services; services/ holds 12 directories, and services/legacy-portal/ appears in neither README.md nor ARCHITECTURE.md.
  • 2 of 12 service directories have a README.md; shared/openapi/ holds 3 specs; there is no CHANGELOG.md and no docs workflow in .github/workflows/.

Thread: drift audit on an unfamiliar system → API reference regenerated from ServiceRoutes() and the auth-service source → onboarding path rewritten and then executed on a clean VM (make infra-up / make up) so the doc is verified, not asserted → .github/workflows/docs-drift-guard.yml wired to push: main (payload = merge SHA + PR number + changed code paths; skips when a docs path changed in the same merge, mirroring the existing sast-auto-remediate.yml guards) → Devin Review in both directions (accuracy review of the docs PR; flagging a human code PR that changes ServiceRoutes() without touching docs) → child-session fan-out writing per-service READMEs to one template → scheduled changelog generation. Closes with the shared context layer (AGENTS.md golden-app rules, DeepWiki, Knowledge, a !docs-drift-sweep playbook, MCP), an honest human-in-the-loop section, and outcomes framed as time-to-first-merged-PR and support-question deflection.

Also updated so counts stay accurate:

  • catalog/field-kit-offerings.md — demo count 11 → 15 and the discipline list now includes application-development and technical-documentation (the previous count was already stale).
  • catalog/repos.md — the otterworks entry links the new demo.

No demos/*/README.md index was added: no other demos/ discipline directory uses one. No link was added from labs/technical-documentation/README.md because "demo" verbiage is not permitted under labs/.

Link to Devin session: https://partner-workshops.devinenterprise.com/sessions/f510f35f9e5f47e0bc746fd7084fd65e

@bsmitches bsmitches self-assigned this Jul 27, 2026
@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

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