Repository navigation
[OP-20572] Update development concepts docs - #26307
Merged
Merged
Conversation
oliverguenther
approved these changes
Oct 26, 2026
oliverguenther
left a comment
Member
There was a problem hiding this comment.
I skimmed through the changes, they look reasonable to me 👍
Adds guidance for new code and fixes stale content. https://community.openproject.org/wp/OP-20572
Adds guidance for new code and fixes the samples. https://community.openproject.org/wp/OP-20572
Modernises the Angular samples and fixes stale names. https://community.openproject.org/wp/OP-20572
Fixes stale method and class names. https://community.openproject.org/wp/OP-20572
Fixes the dead API link and stale names. https://community.openproject.org/wp/OP-20572
Fixes stale paths and class names. https://community.openproject.org/wp/OP-20572
Fixes the locale export details and samples. https://community.openproject.org/wp/OP-20572
Fixes stale helpers and resolves the TODOs. https://community.openproject.org/wp/OP-20572
Fixes the plugin import and adds conventions. https://community.openproject.org/wp/OP-20572
Updates build, conversion and mention details. https://community.openproject.org/wp/OP-20572
Documents missing behaviour of the concern. https://community.openproject.org/wp/OP-20572
Replaces removed methods and broken samples. https://community.openproject.org/wp/OP-20572
Updates tooling and CSP details. https://community.openproject.org/wp/OP-20572
Removes the empty heading and fixes grammar. https://community.openproject.org/wp/OP-20572
Adds the six missing pages. https://community.openproject.org/wp/OP-20572
myabc
force-pushed
the
docs/op-20572-update-development-concepts
branch
from
October 27, 2026 22:05
8b96c8c to
cba2dd8
Compare
Highlights existing caveats and editor guidance so readers can find constraints and debugging advice while scanning the concept pages. https://community.openproject.org/wp/OP-20572
Makes the maintained build and design-system forks discoverable from their development documentation.
myabc
marked this pull request as ready for review
October 27, 2026 22:11
|
Caution The provided work package version does not match the core version Details:
Please make sure that:
|
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Ticket
https://community.openproject.org/wp/OP-20572
What are you trying to accomplish?
tl;dr for humans: The developer concept pages describe code that has since changed, so this brings them up to date and says what new code should use.
Fixes stale class names, removed methods, broken samples and dead links across
docs/development/concepts/, and adds missing pages to the index.What approach did you choose and why?
One commit per page. Legacy concepts (HAL resources, reactivestates, inline editing) stay fully documented, with a short "choosing an approach" note: Hotwire/Primer for new screens, modern Angular (
inject(), Signals) in existing Angular screens, Akita stores flagged as unmaintained.AI involvement
Collaborative – AI generated a substantial part of the code; I reviewed and understand every line.
Merge checklist