[NFC] Modules documentation update#45
Merged
Merged
Conversation
…ake targets and move server only targets to sources/server
…omponent specific READMEs
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Improve project documentation and streamline the build process for the platform.
Introduce clearer setup instructions, split component-specific guides into their respective directories, and refine Makefile targets for easier development.
Documentation and Onboarding Improvements:
README.md: Rewritten to provide a high-level project overview, describe the system architecture, clarify the repository structure, and offer concise setup instructions for all components. Maintainers for each component are now listed.sources/agent/README.md: Added a dedicated Agent setup guide, including requirements, vcpkg installation, build/run steps, configuration options, and troubleshooting.sources/server/README.md: Added a comprehensive Server guide covering development setup, protobuf code generation, configuration, API overview, and FAQs.