Skip to content

docs: write docs/architecture.md describing the nine-project layout #348

Open

Description

@DeepDiver1975

docs/ holds master-data.md and releasing.md. There is nothing that explains
how the nine projects under src/ fit together, so a new contributor has to
reconstruct the layering from .csproj files before they can judge where a
change belongs.

What to do

Write docs/architecture.md. Everything you need is readable from
LageBuch.sln and the ProjectReference entries in each .csproj — no domain
knowledge and no running the app required.

Cover:

  • The nine projects and one sentence each on what lives there:
    LageBuch.Domain, LageBuch.Persistence, LageBuch.Documents,
    LageBuch.Sync, LageBuch.Sync.Hosting, LageBuch.AppLogic,
    LageBuch.App.Shared, LageBuch.App, LageBuch.App.Android.
  • The reference graph — which project may reference which, derived from the
    actual ProjectReference entries. A small diagram or a nested list both work.
  • The two app heads, desktop and Android, and what they share through
    App.Shared.
  • Where a change goes — a short "if you are changing X, look in Y" table.
    This is the part that saves a newcomer the most time.

Describe what the code does today. If you notice a reference that looks wrong,
mention it in the PR rather than documenting an intention.

Link the new page from the For developers section of README.md.

Verify

Check that every project name and reference you wrote matches the .csproj
files, and that the README link resolves.

Difficulty: easy to medium. No C# required, just careful reading.


New here?

Comment to claim this issue and it is yours. If no pull request appears within
seven days it goes back in the pool, no hard feelings.

Before you open the PR, please skim CONTRIBUTING.md:
commits need DCO sign-off (git commit -s) and a Conventional Commit subject.
Changes under src/ additionally need an entry under ## [Unreleased] in
CHANGELOG.md — CI fails the PR otherwise.

Questions are welcome right here or in
Discussions.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions