Skip to content

docs: "user guide" section cleanup#826

Merged
skrawcz merged 2 commits intomainfrom
docs/cleanup-index
Apr 17, 2024
Merged

docs: "user guide" section cleanup#826
skrawcz merged 2 commits intomainfrom
docs/cleanup-index

Conversation

@zilto
Copy link
Contributor

@zilto zilto commented Apr 16, 2024

Changes

  • Renamed the section from "How To Guides" to "User Guide".
  • Changed the title of "User Guide" pages to be easier to visually scan. Essentially, this consists of shorter titles with the most important word at the beginning
  • changed the order of user guide items
  • updated the list of integrations

Before:
image

After:
image

How I tested this

  • build docs locally

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

Renamed the section from "How To Guides"
to "User Guide".

Changed the title of "User Guide" pages to be
easier to visually scan. Essentially, this consists
of shorter titles with the most important word at
the beginning
@zilto zilto added the documentation Improvements or additions to documentation label Apr 16, 2024
@skrawcz
Copy link
Contributor

skrawcz commented Apr 16, 2024

To me the purpose of the how-to section is for goal oriented people - "I want to do X with Hamilton" where X is a broad concept -- while the integrations section is when X is a specific narrower technology/topic.

So I think the changes mostly look good. Left comments where appropriate.

@zilto
Copy link
Contributor Author

zilto commented Apr 17, 2024

To me the purpose of the how-to section is for goal oriented people - "I want to do X with Hamilton" where X is a broad concept -- while the integrations section is when X is a specific narrower technology/topic.

I agree on the purpose of the "how-to" / "user guide" section. I believe "User guide" pages should mirror frequent Q/A on Slack. Pages on "Feature engineering", "pre-commit", "jupyter notebooks" are good examples.

Many of the current pages are too introductory / generic. In that case, it should be reframed to be part of the "Concepts" section (e.g., "Load data" doesn't add much compared to the materialization page).

@skrawcz skrawcz merged commit 431cc21 into main Apr 17, 2024
@skrawcz skrawcz deleted the docs/cleanup-index branch April 17, 2024 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants