Docs as code
On This Lesson 4 topics
This lesson is planned. The outline below lists the topics it will cover. The full lesson has not been published yet.
In this lesson
keep documents current by treating them like code.
Planned topics
- Store docs in the repository beside the code; change them in the same pull request.
- Review docs; check links and diagram builds in CI.
- Give each document an owner and a review date.
- Delete or archive stale documents.
Draft outline details
Demonstration
a repository layout with docs/architecture, docs/adr, docs/runbooks, and a CI step checking links.
Check your understanding
Why change docs in the same PR as code?
Show answer
So they stay accurate and are reviewed together.
Practice
Apply this lesson with the module's lab, exercises and quiz.
Marking a lesson complete is optional and you can undo it any time. Your progress stays in this browser.