Skip to content

docs: sync in-repo documentation from the project Wiki (DeepWiki)#48

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1782402288-docs-from-wiki
Open

docs: sync in-repo documentation from the project Wiki (DeepWiki)#48
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1782402288-docs-from-wiki

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Jun 25, 2026

Copy link
Copy Markdown

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 new docs/ 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 main README.md).
  • 32 page files mirroring the wiki hierarchy:
    • Overview, Getting Started
    • Architecture (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/:

[Architecture](#3)                  -> [Architecture](3-architecture.md)
[src/app/app.config.ts]()           -> `src/app/app.config.ts`   (empty-target source refs -> inline code)
[README.md](README.md)              -> [README.md](../README.md) (repo-root paths get ../ since docs live in docs/)

Mermaid diagrams and tables from the wiki are preserved.

Validation

  • All intra-doc and ../-relative source links resolve (checked: 0 missing).
  • bun run format:check passes; the husky pre-commit lint-staged (prettier) ran clean on the added files.

The README.md change adds a short "Documentation" section pointing at docs/README.md.

Link to Devin session: https://app.devin.ai/sessions/b5266837d55e4415889bc076351ee2e9


Devin Review

Status Commit
⚪ Not started

Run Devin Review

Open in Devin Review (Staging)

Co-Authored-By: ameen <ameen@cognition.ai>
@devin-ai-integration

Copy link
Copy Markdown
Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants