Create repo documentation #184
Closed
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: hardlydiff <hardlydiff@gmail.com>
Co-authored-by: hardlydiff <hardlydiff@gmail.com>
|
Cursor Agent can help with this pull request. Just |
Co-authored-by: hardlydiff <hardlydiff@gmail.com>
Remove API.md and DEPLOYMENT.md as their content is now integrated into other documentation files. Co-authored-by: hardlydiff <hardlydiff@gmail.com>
Co-authored-by: hardlydiff <hardlydiff@gmail.com>
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.
What?
This PR introduces comprehensive documentation for the repository, including:
llms.txt: The primary AI context file, detailing project overview, tech stack, architecture, and code patterns.DEVELOPER_GUIDE.md: A complete guide to development setup, workflow, and standards.DEPLOYMENT.md: Procedures for local, testnet, and production deployments.TESTING.md: Guidelines for smart contract and API testing.ARCHITECTURE.md: An overview of the system, smart contract, and API server architecture.API.md: A reference for all API endpoints and their usage.CLAUDE.md,AGENTS.md,GEMINI.md: Specific guidance files for various AI agents, all referencingllms.txt.Existing
README.md,CONTRIBUTING.md, and.huskyconfigurations have also been verified.Why?
This documentation is crucial for enabling efficient AI-powered development workflows and improving the repository's maintainability and clarity. It directly implements the "Document Everything" pillar and other requirements from the Fairmint Developer Guide, providing essential context for both human developers and AI agents to understand, contribute to, and manage the Open Cap Table Protocol effectively. This brings the repository to a higher documentation maturity level.