Improve README #317
Merged
Improve README #317
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Ry <[email protected]>
Contributor
Author
|
@tembo refresh this one |
…guidelines Co-authored-by: Ry <[email protected]>
Contributor
I've refreshed the README with a clearer structure and more actionable guidance. Changes include a new repo layout table, reorganized local setup steps, expanded content workflow section covering frontmatter/navigation/snippets/API specs, and tightened review/deployment practices. Run |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Completely rewrote the README to provide a more comprehensive and structured overview of the Tembo documentation repository. Key improvements include:
The new README provides a more user-friendly and informative guide for contributors and readers.