Skip to content

Simplify documentation and link examples from the API - #69

Merged
dcajal merged 1 commit into
mainfrom
docs/simplify-user-documentation
Aug 12, 2026
Merged

Simplify documentation and link examples from the API#69
dcajal merged 1 commit into
mainfrom
docs/simplify-user-documentation

Conversation

@dcajal

@dcajal dcajal commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • simplify the README, landing page, feature overview, and persistent contributor guidance
  • remove the standalone Examples section and its per-example documentation pages
  • link each of the nine executable example scripts from its corresponding API page
  • remove implementation-history wording from public example descriptions

Impact

The API remains the single Python reference. Users can move directly from a function signature and docstring to executable source without maintaining a second explanatory page for each example.

Validation

  • .venv\Scripts\python.exe -m pytest (220 passed)
  • .venv\Scripts\python.exe -m mkdocs build --strict
  • verified nine API links for nine executable example scripts
  • git diff --check

@dcajal
dcajal merged commit b543fbd into main Aug 12, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant