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.

Sign up for GitHub

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

Jump to bottom

Adds shortened main.md for docs #88

Merged
merged 2 commits into from
Mar 2, 2023
Merged

Adds shortened main.md for docs #88

merged 2 commits into from
Mar 2, 2023

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented Mar 2, 2023

The github README was a little too much, as we should just direct users to the most obvious next steps.

Could perhaps use some more wordsmithing.

Changes

How I tested this

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.

@skrawcz
Adds shortened main.md for docs
d9b12c5 
The github README was a little too much, as we should
just direct users to the most obvious next steps.

Could perhaps use some more wordsmithing.
elijahbenizzy
elijahbenizzy reviewed Mar 2, 2023
View reviewed changes
docs/main.md Outdated
[tryhamilton.dev](https://www.tryhamilton.dev) utilizes pyodide and runs python in the browser - note, a good
internet connection is recommended.

Otherwise hop on over to our [getting started guide](getting-started/index.rst).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Getting started also links to tryhamilton -- wroth doing it twice?

@elijahbenizzy elijahbenizzy marked this pull request as ready for review March 2, 2023 22:37
@skrawcz skrawcz merged commit a5eaa8e into main Mar 2, 2023
@skrawcz skrawcz deleted the docs-main branch March 2, 2023 22:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elijahbenizzy elijahbenizzy elijahbenizzy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@skrawcz @elijahbenizzy