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

Refresh README #908

Merged
merged 42 commits into from
Jan 2, 2025
Merged

Refresh README #908

merged 42 commits into from
Jan 2, 2025

Conversation

yeldarby
Copy link
Contributor

Description

This PR updates the README with a new focus on Workflows & our latest value props.

Followup work: moving the installation & device specific instructions to the docs, updating the docs to follow the happy path.

Type of change

  • This change is a documentation update

How has this change been tested, please provide a testcase or example of how you tested the change?

Non-functional change; previewed on GitHub

Any specific deployment considerations

No deployment needed

Docs

  • Docs updated? What were the changes: This is the first step in refreshing all the docs.

Copy link
Contributor

@hansent hansent left a comment

Choose a reason for hiding this comment

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

lgtm, much better than before.

we probably want to make similar updates to docs/index.md or find a way to link /include the content (its almost one for one copy of previous readme)

@yeldarby
Copy link
Contributor Author

yeldarby commented Jan 2, 2025

I think that page should actually be more of a "landing page" but yes, agree it needs a major revamp. It's on my near-term todo list.

@yeldarby yeldarby merged commit 1b4f4af into main Jan 2, 2025
71 checks passed
@yeldarby yeldarby deleted the revamped-docs branch January 2, 2025 20:45
yeldarby added a commit that referenced this pull request Jan 2, 2025
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.

2 participants