Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor docs; minimal content change #621

Merged
merged 4 commits into from
Jan 8, 2024
Merged

refactor docs; minimal content change #621

merged 4 commits into from
Jan 8, 2024

Conversation

zilto
Copy link
Collaborator

@zilto zilto commented Jan 8, 2024

Refactored the documentation, focusing on cleaning up the navigation pane.

Changes

  • flattened customizing-execution into graph-adapters and lifecycle-hooks
  • renamed getting-started to get-started
  • shortened formulations (e.g., Reference Documentation -> Reference, Overview of Concepts -> Concepts)
  • Merged some pages
  • Created learning-resources.md
  • Created Integrations subheader

How I tested this

I compiled the docs and successfully ran it locally.

Notes

  • While the site may work, this may break links pointing to the docs (e.g., tryhamilton, blogs)
  • Two pages were left unindexed under the unorganized-docs folder

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.

@zilto zilto added the documentation Improvements or additions to documentation label Jan 8, 2024
Copy link
Contributor

sweep-ai bot commented Jan 8, 2024

Apply Sweep Rules to your PR?

  • Apply: All new business logic should have corresponding unit tests.
  • Apply: Refactor large functions to be more modular.
  • Apply: Add docstrings to all functions and file headers.

@skrawcz
Copy link
Collaborator

skrawcz commented Jan 8, 2024

Just change substack -> blog.

@skrawcz
Copy link
Collaborator

skrawcz commented Jan 8, 2024

This doesn't render properly as a link on the comparison page:

[Hamilton + Metaflow] example: https:/outerbounds/hamilton-metaflow

Copy link
Collaborator

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just those two changes I think, otherwise LGTM.

@zilto zilto merged commit 934f054 into main Jan 8, 2024
22 checks passed
@zilto zilto deleted the docs/refactor branch January 8, 2024 22:54
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