Fix/doc updates#910
Merged
Merged
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
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.
closes #899
closes #902
closes #906
closes #907
Description
This PR resolves four documentation issues across the repository:
README.mdto ensure the header and Overview section read cleanly.frontendpackage with FlowFi-specific content. Also added package-specificREADME.mdfiles for thebackendandcontractsdirectories to orient new contributors.CONTRIBUTING.mdso the main heading renders correctly, updated allflowfi/flowfiURLs to the correctLabsCrypt/flowfirepository, and corrected the PostgreSQL port documentation to5433(matching thedocker-compose.ymlmapping).backend/docs/AUTHENTICATION.mdin the rootREADME.md's API Documentation section, and optionally cross-linked it from the Authentication Flow section indocs/ARCHITECTURE.mdto ensure contributors have an entry point to the auth model.Files Touched
README.mdfrontend/README.mdbackend/README.mdcontracts/README.mdCONTRIBUTING.mddocs/ARCHITECTURE.mdTesting Instructions
README.mdandCONTRIBUTING.mdrender properly on GitHub without stray markdown characters.LabsCrypt/flowfirepository and that the cross-links (e.g., to the Authentication Doc) resolve successfully.