Skip to content

Polish Great Docs onboarding and API conventions - #286

Merged
uriahf merged 5 commits into
mainfrom
agent/docs-polish-and-conventions
Aug 11, 2026
Merged

Polish Great Docs onboarding and API conventions#286
uriahf merged 5 commits into
mainfrom
agent/docs-polish-and-conventions

Conversation

@uriahf

@uriahf uriahf commented Aug 11, 2026

Copy link
Copy Markdown
Owner

What changed

  • adds the same rtichoke-blog reproducible-examples link used by the R package
  • makes uv add rtichoke the recommended project-managed installation path, with pip retained as an alternative
  • adds a concise Naming Conventions guide covering prepare_*, create_*, plot_*, and _times
  • adds a lightweight Blog ↗ link to the Great Docs navbar pointing to the main rtichoke blog

Why

This keeps the existing site architecture intact while making the Python documentation easier to navigate and more consistent with the R package documentation.

Validation

The repository's existing documentation workflow should build Great Docs and publish a PR-specific rendered preview under pr-preview/. Please review the rendered navbar, Getting Started page, and Naming Conventions page before merging.

Scope

No blog content is embedded into Great Docs and no Great Docs page shell is replaced or restyled by JavaScript.

@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-08-11 08:29 UTC

@uriahf
uriahf marked this pull request as ready for review August 11, 2026 08:27
@uriahf
uriahf merged commit f88c481 into main Aug 11, 2026
3 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