Chore: doc update #12
Open
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR performs a comprehensive documentation update for the LogChain system, adding a new introduction document and restructuring existing documentation to be more user-friendly and consistent. The update reorganizes README files across multiple modules with clearer structure, concise descriptions, and practical examples.
Key Changes:
- Added new
docs/introduction.mdproviding a high-level system overview, use cases, and integration options - Updated all service-level README files (
cmd/*/README.md) to focus on development setup rather than exhaustive API documentation - Consolidated and restructured documentation in
ingress/,ingestion/,query/,processing/, andblockchain/modules - Removed obsolete files (
config/CONFIG_GUIDE.md,blockchain/client/README.md,ingress/docker-compose.yml) - Fixed a JSON syntax error in
scripts/test-ingestion-query-api.sh - Updated certificate paths in test scripts from
regulatory-001tomember-001
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/test-ingestion-query-api.sh | Fixed JSON syntax error - removed extra closing brace |
| scripts/test-consortium-audit-api.sh | Updated client certificate paths from regulatory-001 to member-001 |
| scripts/README.md | New comprehensive script documentation with usage examples |
| query/README.md | Restructured to focus on architecture, APIs, and key features |
| processing/README.md | New documentation for batch processing worker logic |
| ingress/docker-compose.yml | Removed - deployment now handled by root docker-compose.yml |
| ingress/README.md | Major restructure with clearer sections and updated configuration |
| ingestion/service/README.md | Reorganized to emphasize structure and batch processing |
| ingestion/adapters/README.md | Improved organization with better examples and security practices |
| ingestion/README.md | Simplified overview focusing on components and data flow |
| docs/introduction.md | New file providing high-level system overview and use cases |
| docs/design.md | Updated technical details about Nginx, authentication, and component descriptions |
| docs/chainmaker_deployment.md | Simplified Rust version guidance and improved config instructions |
| config/README.md | New configuration guide replacing CONFIG_GUIDE.md |
| config/CONFIG_GUIDE.md | Removed - replaced by config/README.md |
| cmd/query/README.md | Simplified to focus on development setup |
| cmd/ingestion/README.md | Streamlined with emphasis on local development workflow |
| cmd/engine/README.md | Restructured to focus on architecture and development setup |
| blockchain/client/README.md | Removed - content consolidated into blockchain/README.md |
| blockchain/README.md | New module overview with clearer structure |
| README.md | Comprehensive rewrite with architecture diagram and quick start guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/introduction.md
Outdated
|
|
||
| - [Technical Architecture](design.md) - Detailed system design and specifications | ||
| - [Deployment Guide](chainmaker_deployment.md) - Self-hosted deployment instructions | ||
| - [GitHub Repository](https://github.com/your-org/logchain) - Source code and documentation |
There was a problem hiding this comment.
The GitHub repository link uses a placeholder URL "https://github.com/your-org/logchain". This should be updated to the actual repository URL or removed if not applicable.
Suggested change
| - [GitHub Repository](https://github.com/your-org/logchain) - Source code and documentation |
| ### Direct API Integration | ||
| ```bash | ||
| # Submit log via HTTPS | ||
| curl -X POST https://logchain.example.com/v1/logs \ |
There was a problem hiding this comment.
The example domain "logchain.example.com" is used throughout the examples. While this is acceptable for documentation, consider adding a note indicating this is a placeholder that should be replaced with the actual deployment domain.
…ts integration with blockchain technology
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.
Note：需要等待 Feat: benthos integration #11 合入