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

Reorganize and improve documentation #81

Merged
merged 5 commits into from
Jul 11, 2024
Merged

Reorganize and improve documentation #81

merged 5 commits into from
Jul 11, 2024

Conversation

rlskoeser
Copy link
Member

@rlskoeser rlskoeser commented Jun 6, 2024 •
edited
Loading

  • move setup/install directions into new developer notes document
  • move all-contributors content to separate file (the bot updates the file automatically; seems better+easier to keep separate)
  • reorganize examples directory and add a minimal readme

preparatory cleanup for adding some example usage to the readme

note: this branch has stacked PRs; it should be merged with a merge commit to preserve git history

@rlskoeser rlskoeser mentioned this pull request Jun 6, 2024
Merged
@rlskoeser rlskoeser requested a review from jdamerow June 13, 2024 15:58
ColeDCrawford
ColeDCrawford approved these changes Jul 11, 2024
View reviewed changes
Copy link
Collaborator

@ColeDCrawford ColeDCrawford left a comment

Choose a reason for hiding this comment

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

👍

DEVELOPER_NOTES.md
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks, these are helpful and comprehensive and should help folks get up and running quickly

@rlskoeser rlskoeser merged commit e66eeff into develop Jul 11, 2024
5 checks passed
@rlskoeser rlskoeser deleted the feature/readme-cleanup branch July 11, 2024 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ColeDCrawford ColeDCrawford ColeDCrawford approved these changes

@jdamerow jdamerow Awaiting requested review from jdamerow

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
@rlskoeser @ColeDCrawford