Commit graph

15 commits

Author SHA1 Message Date
Johannes Millan
42e6626b76 docs(sync): consolidate sync docs + enforce the contributor model
Collapse the sprawling, partly-stale docs/sync-and-op-log/ tree into a
small authoritative set and make the sync-correctness invariant
partly lint-enforced instead of convention-only.

Docs:
- Delete superseded/duplicate/provably-stale design, plan, and
  background-research docs (quick-reference, the architecture-diagrams
  monolith, the "Hybrid Manifest" docs describing code that does not
  exist, completed long-term plans, LLM-synthesis analyses).
- Salvage load-bearing decision history into the surviving docs before
  deletion: rejected-alternatives rationale -> operation-log-architecture
  ("Why this architecture"); vector-clock pruning incident history ->
  vector-clocks.md; archive-payload optimization -> architecture E.7.
- Add contributor-sync-model.md as the single-invariant entry point
  (one user intent = one op; replayed/remote ops must not re-trigger
  effects), with a decision table mapping to the enforcing linters.
- Repoint external/internal cross-refs; add CONTRIBUTING.md + CLAUDE.md
  pointers; record the migration in a dated docs/plans/ design doc.

Enforcement (new eslint-local-rules):
- no-actions-in-effects (error): effects must inject LOCAL_ACTIONS /
  ALL_ACTIONS, never the raw @ngrx/effects Actions stream.
- no-multi-entity-effect (warn, heuristic): flags a literal returned
  array of >=2 action-creator calls; docstring + valid-case specs pin
  exactly which shapes are and are not detected.
- run-specs.js runner wired into `npm run lint` via test:lint-rules;
  refuses to run under test-framework globals and counts RuleTester.run
  invocations so a spec that asserts nothing fails instead of passing.
- Correct the ALL_ACTIONS JSDoc in local-actions.token.ts to match
  reality (archive-operation-handler uses LOCAL_ACTIONS).

Reviewed via parallel multi-agent review; findings W1/W2/W4 and a
dangling doc anchor addressed.
2026-05-15 16:51:50 +02:00
Corey Newton
0fad98fe43
docs/wiki content v0.9 (#7116)
* docs: update link from README to Wiki

* docs: refactor from README to Wiki

* docs: refactor README to Wiki
2026-04-09 19:36:23 +02:00
Johannes Millan
b6b51707d3 docs: clean up and organize project documentation
- Remove outdated feature requests from .github/CONTRIBUTING.md (GitLab
  support already exists) and add commit message format section
- Improve PR template with type-of-change checkboxes and checklist
- Update commit guideline links in README and CONTRIBUTING.md to
  reference the project's own format instead of external angular.js docs
- Add "only edit en.json" rule to TRANSLATING.md and clarify workflow
- Update add-new-integration.md provider list to match codebase (add
  Trello, ClickUp, Linear, Azure DevOps, Nextcloud Deck; note GitHub
  plugin migration; fix type name to BuiltInIssueProviderKey)
- Add cross-references between mac certificate docs and remove 240-line
  duplicate section from update-mac-certificates.md
- Clean up update-android-app.md (specify npm version args, collapse
  deprecated workflow, translate German UI labels to English)
- Add context to howto-refresh-snap-credentials.md
- Fix fine-grained token note in github-access-token-instructions.md
- Fix absolute URL to relative path in gitlab-access-token-instructions.md
- Fix grammar in i18n-script-usage.md
- Add status headers to all 19 long-term plan files (Planned, Completed,
  Archived with reason, Investigation Complete)
- Fix broken relative link in hybrid-manifest-architecture.md
- Delete supersync-scenarios-simplified.md (duplicate of
  supersync-scenarios.md; known issues already covered there)
- Rename vector-clock-pruning-research.md to
  vector-clock-history-and-alternatives.md for clarity
2026-03-10 10:22:56 +01:00
Peter
1b88756d88
fix: README development links (#6261)
Currently the links point to top of the main readme page.
2026-01-29 20:05:15 +01:00
Johannes Millan
08971fce47 docs: add info about how to translate stuff #5893 2026-01-05 18:05:45 +01:00
Johannes Millan
1a79592aca build: update links to match our new organization 2026-01-05 14:45:06 +01:00
iamahens
a86d7f5ccf fix typo 2023-11-15 16:25:41 +01:00
James F. Carroll
28b4e054a8 Update CONTRIBUTING.md
improved text for clarity
2023-11-15 16:24:55 +01:00
Ping
12f4dfeea6 Update CONTRIBUTING.md
Add link to the "Translations" (language) folder
2022-01-08 16:24:50 +01:00
Johannes Millan
79e63eb606 docs: update contributing sections 2021-12-14 17:07:39 +01:00
Johannes Millan
149585217c
Update CONTRIBUTING.md 2021-03-18 19:36:58 +01:00
Johannes Millan
fa58f4c3a7 docs: add sponsor the project link #925 2021-02-24 10:27:26 +01:00
Johannes Millan
55a9014692 docs: update contributing stuff 2020-09-25 16:49:02 +02:00
Johannes Millan
72583615ab docs: update contributing stuff 2020-09-25 16:46:14 +02:00
Johannes Millan
445a1ac2bf build: add CONTRIBUTING.md 2020-09-21 21:50:07 +02:00