Skip to content

docs: publish the LoopGuard docs URL and finish production cleanup #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mahimathacker merged 12 commits into from
Oct 30, 2026
Merged

docs: publish the LoopGuard docs URL and finish production cleanup #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0637df1
docs: link README to the published LoopGuard documentation
mahimathacker Oct 30, 2026
5f41c3e
docs: configure discovery for the published documentation domain
mahimathacker Oct 30, 2026
1fbccb0
docs: use the claimed LoopGuard documentation domain
mahimathacker Oct 30, 2026
033157e
docs: record the primary repository as the publishing source
mahimathacker Oct 30, 2026
922965d
docs: outline agent and evaluation diagrams for review
mahimathacker Oct 30, 2026
7babb93
docs: outline callback and trace workflow diagrams
mahimathacker Oct 30, 2026
6e96c36
docs: outline demo evaluation and maintenance diagrams
mahimathacker Oct 30, 2026
b577767
docs: add a diagram review index and Figma handoff
mahimathacker Oct 30, 2026
7f60618
docs: remove diagram placeholders for chat-only review
mahimathacker Oct 30, 2026
ebac28b
docs: clarify the homepage quick start and detection model
mahimathacker Oct 30, 2026
a9a5306
docs: remove unfinished captures and internal scaffolding notes
mahimathacker Oct 30, 2026
0d04d24
docs: keep maintenance schedule guidance current
mahimathacker Oct 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,9 @@ a documentation update covers a code change, and it does not rewrite content.
Unresolved publication placeholders warn during normal checks. Before a release,
run `python scripts/check_docs.py --release` to fail if any remain in reader-facing
content. Version-tag builds and the workflow's release-readiness option run the
same strict check. The current missing hosted URL and two screenshots must be
resolved before that check can pass.
same strict check.

Read the [contributing guide](docs/development/contributing.mdx) for CI behavior,
or [add a trace regression case](docs/guides/regression-checks.mdx) to document
expected healthy and stuck behavior. See [the maintainer handoff](docs/README.md)
for local preview and later publishing.
expected healthy and stuck behavior. See [the documentation guide](docs/README.md)
for local preview and publishing.
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Python versions](https://img.shields.io/pypi/pyversions/loopguard-runtime)](https://pypi.org/project/loopguard-runtime/)
[![PyPI monthly downloads](https://img.shields.io/pypi/dm/loopguard-runtime)](https://pypi.org/project/loopguard-runtime/)

[![Docs](https://img.shields.io/badge/Docs-2563EB?style=for-the-badge)](docs/index.mdx)
[![Docs](https://img.shields.io/badge/Docs-2563EB?style=for-the-badge)](https://loopguard.mintlify.site/)
[![PyPI](https://img.shields.io/badge/PyPI-3775A9?style=for-the-badge)](https://pypi.org/project/loopguard-runtime/)
[![Demo](https://img.shields.io/badge/Demo-FF0000?style=for-the-badge)](https://youtu.be/i5XRrvFoPA0)
[![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge)](https://github.com/mahimathacker/loopguard)
Expand Down Expand Up @@ -33,8 +33,7 @@ the actual decision.

[![LoopGuard catching a real search agent in a semantic loop and interrupting the run](ui/public/realagentloop.png)](https://youtu.be/i5XRrvFoPA0)

An agent keeps searching for an impossible confirmation. LoopGuard flags repeated
intent and interrupts the demo. This repository capture shows an earlier UI layout.
Screenshot from a LoopGuard demo run showing repeated intent and an interrupted run.
The [four visual examples](docs/demo/scenarios.mdx) pair detection explanations
with Python SDK code so you can inspect the same behavior in your own program.

Expand Down Expand Up @@ -132,7 +131,7 @@ harness. [Evaluation and its limits →](docs/development/evaluation.mdx)

## Documentation

**Hosted documentation:** [DOCS URL TO ADD AFTER DEPLOYMENT]
**Hosted documentation:** [Read the LoopGuard docs](https://loopguard.mintlify.site/).

The [Mintlify source](docs/index.mdx) covers the full developer journey.
The [concept guides](docs/concepts/agents-and-loops.mdx) explain agent loops,
Expand Down
Loading
Loading