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
Open
Add docs-as-code / developer-experience demo for the technical writing job function#171devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
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
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
mainrather than invented examples — this is what makes the thread demo-able without staging anything:docs/api-route-matrix.mdstates the gateway "currently has no/api/v1/templatesprefix inServiceRoutes", that/api/v1/foldersis not routed, and that reports are not routed — whileConfig.ServiceRoutes()inservices/api-gateway/internal/config/config.gomaps all three today.ARCHITECTURE.md§ 11 documents the web frontend atfrontend/web-app/; the directory onmainisfrontend/client-app/.README.md's Services table lists 11 backend services;services/holds 12 directories, andservices/legacy-portal/appears in neitherREADME.mdnorARCHITECTURE.md.README.md;shared/openapi/holds 3 specs; there is noCHANGELOG.mdand 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.ymlwired topush: main(payload = merge SHA + PR number + changed code paths; skips when a docs path changed in the same merge, mirroring the existingsast-auto-remediate.ymlguards) → Devin Review in both directions (accuracy review of the docs PR; flagging a human code PR that changesServiceRoutes()without touching docs) → child-session fan-out writing per-service READMEs to one template → scheduled changelog generation. Closes with the shared context layer (AGENTS.mdgolden-app rules, DeepWiki, Knowledge, a!docs-drift-sweepplaybook, 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.mdindex was added: no otherdemos/discipline directory uses one. No link was added fromlabs/technical-documentation/README.mdbecause "demo" verbiage is not permitted underlabs/.Link to Devin session: https://partner-workshops.devinenterprise.com/sessions/f510f35f9e5f47e0bc746fd7084fd65e