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

Update README.md #614

Merged
merged 16 commits into from
Dec 10, 2024
Merged

Update README.md #614

merged 16 commits into from
Dec 10, 2024

Conversation

ehennestad
Copy link
Collaborator

@ehennestad ehennestad commented Nov 2, 2024 •
edited
Loading

Motivation

Update appearance of readme

  • Add simple table of contents at the top linking to important sections
  • Add link to new documentation page
  • Reorganize Setup -> Installation + Getting Started
  • Update html livescript links (new documentation page)
  • Remove sections
    • API Documentation
    • Sources
    • Data Dimensions
    • Testing
    • FAQ

Checklist

  • Have you ensured the PR description clearly describes the problem and solutions?
  • Have you checked to ensure that there aren't other open or previously closed Pull Requests for the same change?
  • If this PR fixes an issue, is the first line of the PR description fix #XX where XX is the issue number?

@ehennestad ehennestad marked this pull request as ready for review December 9, 2024 20:49
@ehennestad ehennestad requested a review from bendichter December 9, 2024 20:49
@bendichter bendichter merged commit 4bf41dc into master Dec 10, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bendichter bendichter bendichter 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
@ehennestad @bendichter