Skip to content

Commit 986b6fc

Browse files
committed
chore!: remove MkDocs documentation generation feature
Remove all MkDocs-based documentation infrastructure from the project. This simplifies the project by eliminating the documentation build system that was generating GitHub Pages documentation from example files. Changes include: - Remove mkdocs.yml configuration file - Remove scripts/build_docs.py documentation builder script - Remove .github/workflows/docs.yml CI workflow for deploying docs - Remove docs optional dependency group from pyproject.toml (mkdocs-terminal, pygments, pymdown-extensions) - Remove docs-serve and docs-build targets from justfile - Update CLAUDE.md to remove documentation command references The uv.lock file is updated to reflect the removed dependencies. BREAKING CHANGE: The `docs` optional dependency group and related commands (`make docs-serve`, `make docs-build`) are no longer available.
1 parent ad8fce4 commit 986b6fc

File tree

7 files changed

+8
-407
lines changed

7 files changed

+8
-407
lines changed

.github/workflows/docs.yml

Lines changed: 0 additions & 34 deletions
This file was deleted.

CLAUDE.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,6 @@ make test # Run all tests
3030
make test-tools # Run tool-specific tests
3131
make test-examples # Run example tests
3232

33-
# Documentation
34-
make docs-serve # Build and serve docs locally (http://localhost:8000)
35-
make docs-build # Build docs for deployment
36-
3733
# MCP Development
3834
make mcp-inspector # Run MCP server inspector for debugging
3935
```
@@ -120,9 +116,3 @@ toolset = StackOneToolSet(
120116
- Core execution logic in `StackOneTool.execute()` method
121117
- HTTP configuration via `ExecuteConfig` class
122118
- Response handling in `_process_response()`
123-
124-
### Updating Documentation
125-
126-
- Examples requirements: See @./.cursor/rules/examples-standards
127-
- Run `make docs-serve` to preview changes
128-
- MkDocs config in `mkdocs.yml`

justfile

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,6 @@ test-examples:
2626
mypy:
2727
uv run mypy stackone_ai
2828

29-
# Build and serve docs locally
30-
docs-serve:
31-
uv run scripts/build_docs.py
32-
uv run mkdocs serve
33-
34-
# Build docs for deployment
35-
docs-build:
36-
uv run scripts/build_docs.py
37-
uv run mkdocs build
38-
3929
# Run MCP server inspector for debugging
4030
mcp-inspector:
4131
uv sync --all-extras

mkdocs.yml

Lines changed: 0 additions & 51 deletions
This file was deleted.

pyproject.toml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,6 @@ examples = [
5757
"openai>=1.63.2",
5858
"python-dotenv>=1.0.1",
5959
]
60-
docs = [
61-
"mkdocs-terminal>=4.7.0",
62-
"pygments>=2.12",
63-
"pymdown-extensions"
64-
]
6560

6661
[dependency-groups]
6762
dev = [

scripts/build_docs.py

Lines changed: 0 additions & 82 deletions
This file was deleted.

0 commit comments

Comments
 (0)