docs: sync in-repo documentation from the project Wiki (DeepWiki)#48
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs: sync in-repo documentation from the project Wiki (DeepWiki)#48devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: ameen <ameen@cognition.ai>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
Summary
Brings the project's documentation into the repo. The repo previously had no in-repo developer docs beyond
README.md/CLAUDE.md, and the only existing "wiki" for this app is its DeepWiki. This PR imports that full wiki (30 pages) into a newdocs/folder so the documentation lives alongside the code and is browsable on GitHub.Note: this repo has no GitHub Wiki enabled, and there is no matching page in the cog-gtm Confluence or Notion — so "the Wiki" here is the DeepWiki. Happy to re-point at a different source if intended.
What's added
docs/README.md— index with the full table of contents (linked from the mainREADME.md).Overview,Getting StartedArchitecture(bootstrap/config, HTTP pipeline, auth, routing)Core Services(UserService, interceptors, JwtService, domain services)Feature Modules(articles + list/detail/editor, profiles, settings/auth UI, home/feed)Shared Components & Directives(layout, favorite/follow buttons, conditional rendering/errors)Testing Strategy(Vitest unit, Playwright E2E, error-handling/feature tests)Build & Deployment(build config, CI/CD, dependencies)Link handling during import
The raw wiki uses anchor links and source-reference links that don't resolve as in-repo files. These were rewritten so everything is browsable from
docs/:Mermaid diagrams and tables from the wiki are preserved.
Validation
../-relative source links resolve (checked: 0 missing).bun run format:checkpasses; the husky pre-commitlint-staged(prettier) ran clean on the added files.The
README.mdchange adds a short "Documentation" section pointing atdocs/README.md.Link to Devin session: https://app.devin.ai/sessions/b5266837d55e4415889bc076351ee2e9
Devin Review