Add comprehensive documentation wiki for Docs Drift Guard#10
Merged
Conversation
Co-Authored-By: unknown <>
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:
|
Co-Authored-By: unknown <>
4 tasks
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
Adds a full documentation wiki in
docs/wiki/with 15 Markdown pages covering every aspect of the Docs Drift Guard project. All content was derived from reading the README and source code — no application code was changed.Pages added:
baseline,check,auditcommands with exit codesUpdates since initial commit
API uses "name"— corrected toAPI uses "first_name" + "last_name"(caught by Devin Review).Review & Testing Checklist for Human
app/main.py, not by running the API. Verify the documented request/response fields (especially forPATCH /v1/employeesandPOST /v1/employees) match the actual Pydantic models. The Demo-Walkthrough already had one incorrect field name — there may be others.docs/wiki/Home.mdon the PR branch and click several cross-page links (e.g.[Drift Detection](Drift-Detection.md),[CLI Reference](CLI-Reference.md)) to confirm they resolve correctly within thedocs/wiki/directory.drift_guard/guard.py. An incorrect exit code in the docs could mislead CI/CD setup.Suggested test plan: Browse
docs/wiki/Home.mdon the PR branch on GitHub, follow links to 3–4 pages, and compare a few specific claims (field names, exit codes, command syntax) against the source code.Notes
docs/wiki/directory on GitHub. They won't work as a GitHub Wiki (the built-in wiki feature) — they're repo-hosted docs.main(PATCH 500 errors + schemabiofield mismatch in contract tests) and unrelated to this PR. The check is not marked as required.