docs: Add quick-start sections to component README files #5542
+74
−0
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
- Add quick-start commands to api/README.md - Add quick-start commands to catalog/README.md - Add quick-start commands to frontend/README.md - Add quick-start commands to ingestion_server/README.md - Add package overview to packages/README.md These additions help developers quickly understand how to work with each component without needing to navigate to full documentation first.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Added quick-start sections to component README files (api, catalog, frontend, ingestion_server, packages) with commonly used commands. This helps developers quickly see how to run each component without navigating to full documentation.
Changes
just up,just test, etc.