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

updated Welcome Page #627

Merged
merged 2 commits into from
Jan 12, 2024
Merged

updated Welcome Page #627

merged 2 commits into from
Jan 12, 2024

Conversation

zilto
Copy link
Collaborator

@zilto zilto commented Jan 11, 2024

Updated the landing page of the Hamilton documentation.

Changes

  • Removed the comparison grid
  • Shorter intro paragraph with layperson language
  • Brief "Why should you use Hamilton" (this will be detailed in the user journey section)
  • Architecture overview
  • Who is using Hamilton figure with short companies descriptions

How I tested this

  • The docs were compiled and display properly locally
  • User a spelling + grammar check

Notes

The snippet for one image renders weirdly for local mardown previews, but is correctly compiled by the myst documentation parser.

Copy link
Contributor

sweep-ai bot commented Jan 11, 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.

This is an automated message generated by Sweep AI.

@skrawcz
Copy link
Collaborator

skrawcz commented Jan 11, 2024

@zilto we need the comparison grid somewhere -- thoughts?

@zilto
Copy link
Collaborator Author

zilto commented Jan 11, 2024

@zilto we need the comparison grid somewhere -- thoughts?

I meant to add it back in another section, but forgot to do it for this PR. I believe it could live under "Why should you use Hamilton?" or "Integrations"

@skrawcz
Copy link
Collaborator

skrawcz commented Jan 11, 2024

@zilto we need the comparison grid somewhere -- thoughts?

I meant to add it back in another section, but forgot to do it for this PR. I believe it could live under "Why should you use Hamilton?" or "Integrations"

cool -- I've gotten feedback that it's something people like to see -- why not just have it at the bottom then? Since to me part of this welcome is helping position "WHERE" Hamilton is in relation to other things. So either another page with a prominent link off of this one to this comparison, or have it at the bottom?

docs/main.md Outdated Show resolved Hide resolved
docs/main.md Outdated Show resolved Hide resolved
docs/main.md Outdated Show resolved Hide resolved
@skrawcz skrawcz merged commit b1e1377 into main Jan 12, 2024
22 checks passed
@skrawcz skrawcz deleted the docs/welcome-page branch January 12, 2024 23:50
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.

3 participants