Skip to content

Docs truth: install name, real dataset ids, quickstart output - #12

Merged
marcocaggioni merged 1 commit into
masterfrom
docs-truth
Oct 3, 2026
Merged

marcocaggioni merged 1 commit into
masterfrom
docs-truth

Conversation

@marcocaggioni

Copy link
Copy Markdown
Member

Docs/skill hygiene (Phase 0 of the ecosystem integration plan):

  • pip install rheodata → pip install rheopy-rheodata in docs/index.md
    and the data-discovery skill (SKILL.md, USAGE.md) — the bare name is
    an abandoned 2020 package; the skill's own install step failed at step one.
  • Replaced fictional dataset ids with real ones: docs/index.md quickstart
    used carbopol_2020 and the rheodata/__init__.py docstring used
    carbopol_flow_25C (with sample="s1") — neither exists. Now
    caggioni_pg_carbopol_2pct with its real sample id carbopol_2pct.
  • Quickstart now shows real list() output, per the new docs standard
    (every example shows its output, generated by running the code).

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 rheodata | 🛠️ Build #34912165 | 📁 Comparing 4029540 against latest (16b550f)

  🔍 Preview build  

3 files changed
± api.html
± index.html
± _modules/rheodata.html

@marcocaggioni
marcocaggioni merged commit 19f45c4 into master Oct 3, 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