github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-05-11 09:38:37 -05:00
Code Issues 1.6k Packages Projects Releases 57 Wiki Activity

[PR #6120] [MERGED] docs: Add comprehensive developer documentation #36531

New Issue
Closed
opened 2026-04-20 23:23:38 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-20 23:23:38 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/6120
Author: @MatissJanis
Created: 11/11/2025
Status: ✅ Merged
Merged: 12/4/2025
Merged by: @MatissJanis

Base: master ← Head: chore-improve-docs-0tZ8M

📝 Commits (10+)

  • e1ac4e2 docs: Add comprehensive developer documentation
  • 3405cb7 fix: Correct link path in code-style.md
  • b934c5d Merge branch 'master' into chore-improve-docs-0tZ8M
  • bb1cdcc Merge branch 'master' into chore-improve-docs-0tZ8M
  • e8ef5c1 Merge branch 'master' into chore-improve-docs-0tZ8M
  • 65040e7 docs: Update documentation references and remove outdated notes
  • 9f02a5c Merge branch 'chore-improve-docs-0tZ8M' of github.com:actualbudget/actual into chore-improve-docs-0tZ8M
  • 556ee28 Merge branch 'master' into chore-improve-docs-0tZ8M
  • 2258777 Update release-notes workflow to exclude AGENTS.md from non-docs file checks
  • 86b9e4b Update release-notes workflow to remove AGENTS.md exclusion and add upcoming release notes for missing information in Agents.md

📊 Changes

12 files changed (+884 additions, -38 deletions)

View changed files

📝 AGENTS.md (+17 -7)
📝 packages/docs/docs-sidebar.js (+4 -0)
📝 packages/docs/docs/config/index.md (+1 -1)
➕ packages/docs/docs/contributing/code-style.md (+147 -0)
➕ packages/docs/docs/contributing/development-setup.md (+200 -0)
📝 packages/docs/docs/contributing/index.md (+30 -0)
📝 packages/docs/docs/contributing/project-details/architecture.md (+38 -4)
📝 packages/docs/docs/contributing/project-details/index.md (+98 -25)
➕ packages/docs/docs/contributing/testing.md (+181 -0)
➕ packages/docs/docs/contributing/troubleshooting.md (+160 -0)
📝 packages/docs/docs/contributing/writing-docs.md (+1 -1)
➕ upcoming-release-notes/6120.md (+7 -0)

📄 Description

I asked AI to analyse the docs package to see what documentation is outdated and/or missing and to suggest edits. This is what it came up with. I did a first-pass review and removed/changed some content. But overall, I think these are some solid suggestions we can consider merging.

This PR adds comprehensive developer documentation to help contributors get started with Actual Budget.

Changes

New Documentation Files

  • development-setup.md: Complete guide for setting up development environment, prerequisites, essential commands, and workspace structure
  • testing.md: Comprehensive testing guide covering Lage, Vitest, Playwright, and testing workflows
  • code-style.md: Detailed coding conventions for TypeScript, React, and code style guidelines
  • troubleshooting.md: Common development issues and solutions

Enhanced Existing Documentation

  • contributing/index.md: Added development workflow section and links to new documentation
  • project-details/index.md: Expanded with detailed package descriptions, commands, and structure information
  • architecture.md: Enhanced with more technical details, removed outdated Node.js v16 references
  • AGENTS.md: Updated to reflect that docs are now part of the monorepo

Fixes

  • Fixed outdated command examples in writing-docs.md
  • Updated Node.js documentation links to remove version-specific references
  • Updated sidebar to include new documentation sections

Impact

This documentation provides:

  • Clear setup instructions for new contributors
  • Comprehensive testing strategies and workflows
  • Code style guidelines for consistency
  • Troubleshooting guide for common issues
  • Better understanding of project structure and architecture

All documentation follows the existing style guidelines and maintains consistency with the rest of the docs.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/6120 **Author:** [@MatissJanis](https://github.com/MatissJanis) **Created:** 11/11/2025 **Status:** ✅ Merged **Merged:** 12/4/2025 **Merged by:** [@MatissJanis](https://github.com/MatissJanis) **Base:** `master` ← **Head:** `chore-improve-docs-0tZ8M` --- ### 📝 Commits (10+) - [`e1ac4e2`](https://github.com/actualbudget/actual/commit/e1ac4e20552a629e53936d5949257e48ccfd0d08) docs: Add comprehensive developer documentation - [`3405cb7`](https://github.com/actualbudget/actual/commit/3405cb7781c7bc174312f3c9304ec9e29c35bda3) fix: Correct link path in code-style.md - [`b934c5d`](https://github.com/actualbudget/actual/commit/b934c5dee42782724d3a9c92ac500c20d893225e) Merge branch 'master' into chore-improve-docs-0tZ8M - [`bb1cdcc`](https://github.com/actualbudget/actual/commit/bb1cdcce948b29817cfaad5b5999ffd1bcc38671) Merge branch 'master' into chore-improve-docs-0tZ8M - [`e8ef5c1`](https://github.com/actualbudget/actual/commit/e8ef5c17a5fee9753e5ee603bb03fef9addfe4c7) Merge branch 'master' into chore-improve-docs-0tZ8M - [`65040e7`](https://github.com/actualbudget/actual/commit/65040e7b05b194b9f46db2f4d79d0c503a579124) docs: Update documentation references and remove outdated notes - [`9f02a5c`](https://github.com/actualbudget/actual/commit/9f02a5cc6c702fae0035cc0c6e680b32d4ed63cb) Merge branch 'chore-improve-docs-0tZ8M' of github.com:actualbudget/actual into chore-improve-docs-0tZ8M - [`556ee28`](https://github.com/actualbudget/actual/commit/556ee28cf44bf72e5657d21c8462aa2805ee8bec) Merge branch 'master' into chore-improve-docs-0tZ8M - [`2258777`](https://github.com/actualbudget/actual/commit/225877735685e91adc622960d3dc595c42eaf888) Update release-notes workflow to exclude AGENTS.md from non-docs file checks - [`86b9e4b`](https://github.com/actualbudget/actual/commit/86b9e4be41639f0e98457d20ba4bd075eb915074) Update release-notes workflow to remove AGENTS.md exclusion and add upcoming release notes for missing information in Agents.md ### 📊 Changes **12 files changed** (+884 additions, -38 deletions) <details> <summary>View changed files</summary> 📝 `AGENTS.md` (+17 -7) 📝 `packages/docs/docs-sidebar.js` (+4 -0) 📝 `packages/docs/docs/config/index.md` (+1 -1) ➕ `packages/docs/docs/contributing/code-style.md` (+147 -0) ➕ `packages/docs/docs/contributing/development-setup.md` (+200 -0) 📝 `packages/docs/docs/contributing/index.md` (+30 -0) 📝 `packages/docs/docs/contributing/project-details/architecture.md` (+38 -4) 📝 `packages/docs/docs/contributing/project-details/index.md` (+98 -25) ➕ `packages/docs/docs/contributing/testing.md` (+181 -0) ➕ `packages/docs/docs/contributing/troubleshooting.md` (+160 -0) 📝 `packages/docs/docs/contributing/writing-docs.md` (+1 -1) ➕ `upcoming-release-notes/6120.md` (+7 -0) </details> ### 📄 Description I asked AI to analyse the `docs` package to see what documentation is outdated and/or missing and to suggest edits. This is what it came up with. I did a first-pass review and removed/changed some content. But overall, I think these are some solid suggestions we can consider merging. --- This PR adds comprehensive developer documentation to help contributors get started with Actual Budget. ## Changes ### New Documentation Files - **development-setup.md**: Complete guide for setting up development environment, prerequisites, essential commands, and workspace structure - **testing.md**: Comprehensive testing guide covering Lage, Vitest, Playwright, and testing workflows - **code-style.md**: Detailed coding conventions for TypeScript, React, and code style guidelines - **troubleshooting.md**: Common development issues and solutions ### Enhanced Existing Documentation - **contributing/index.md**: Added development workflow section and links to new documentation - **project-details/index.md**: Expanded with detailed package descriptions, commands, and structure information - **architecture.md**: Enhanced with more technical details, removed outdated Node.js v16 references - **AGENTS.md**: Updated to reflect that docs are now part of the monorepo ### Fixes - Fixed outdated command examples in writing-docs.md - Updated Node.js documentation links to remove version-specific references - Updated sidebar to include new documentation sections ## Impact This documentation provides: - Clear setup instructions for new contributors - Comprehensive testing strategies and workflows - Code style guidelines for consistency - Troubleshooting guide for common issues - Better understanding of project structure and architecture All documentation follows the existing style guidelines and maintains consistency with the rest of the docs. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-20 23:23:38 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
AI generated
API
bank sync
budgeting
bug
can’t replicate
dependencies
docker
documentation
electron
experimental feature
feature
feedback
goal templates
good first issue
help wanted
importers
maintenance
needs info
needs testing
needs triage
needs votes
openid
payees
pull-request
Mirrored from GitHub Pull Request
 regression
reports
responsive
rules
schedules
server
✨ merged
split transactions
tech debt
theme
transaction import
transaction reconciliation
transactions
translations
upstream
user interface
✅ approved
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#36531
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?