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

docs: re-word and simplify, add quick starts where applicable #279

Merged
merged 3 commits into from
Nov 29, 2024
Merged

docs: re-word and simplify, add quick starts where applicable #279

merged 3 commits into from
Nov 29, 2024

Conversation

mmalenic
Copy link
Member

@mmalenic mmalenic commented Nov 28, 2024 •
edited
Loading

Starting with this, I'll leave the deploy directory for another PR.

Changes

  • Simplify and re-word the docs.
  • Add quick starts for runnable crates.
  • Add some clarifying comments for complicated sections like config resolvers.

@mmalenic mmalenic requested a review from brainstorm November 28, 2024 23:55
brainstorm
brainstorm approved these changes Nov 29, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
htsget-config/examples/config-files/basic.toml Show resolved Hide resolved
@brainstorm
Copy link
Member

Nice first pass trims, thanks Marko! I'd probably tackle the SSOT goal with the config first and then back to docs?

@mmalenic mmalenic added this pull request to the merge queue Nov 29, 2024
Merged via the queue into main with commit 274bebb Nov 29, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brainstorm brainstorm brainstorm 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
@mmalenic @brainstorm