Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open Beginner friendly
  • Is something wrong?
#348 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
csharp
Domain
documentation

Research direction

Start with LageBuch.sln and each .csproj file's ProjectReference entries to map the nine projects and their actual dependencies. Write docs/architecture.md with the project summaries, reference graph, desktop and Android app heads, and a change-location table, then link it from the For developers section of README.md. Verify every project and reference against the files and check that the README link resolves.

Written by the indexing model from the issue text.

Description

documentation good first issue

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.

Dominant language
C#
Stars
1
Forks
3
Avg merge
4h 34m
Merged PRs (30d)
182

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from CodeForFire/lagebuch

All issues in CodeForFire/lagebuch

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.