lingui / lingui/js-lingui

Rewrite Monorepo docs

Open
#2,537 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5.9k
Forks
457
Avg merge
1d 23h
Merged PRs (30d)
16

Description

I have this in the back of my mind for a looong time, need to put it as a task and do some day, here are topics i would like to cover:

  • Without Publishable Packages (apps/app-a, apps/app-b, packages/button, packages/dialog, etc)
    Possible strategis:
    • One catalog per app
    • Catalog per package + merging
  • With publishable Packages
    • Avoid having translations in packages if possible, pass copies as Props
    • If not possible:
      • Catalog per package + merging
      • One catalog per whole UI Components library

The thing is that "Monorepo" could be very diffrent from project to project. We need to brainstorm how to structure this information, so the user would find a suitable information without reading unrelated parts.

So something like flow diagram, or wizard:

"Do you publish your packages?" - Yes/No -> go to paragraph 2 or 3

all above is a raw dump of my thoughts, to be improved later

Contributor guide

Open the contributing guide

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.

Research direction

Start by reviewing the listed cases for apps/app-a, apps/app-b, packages/button, and packages/dialog, including publishable and non-publishable package translation strategies. Decide how the documentation should separate scenarios, such as with a flow diagram or wizard. Done means the raw notes are reorganized into coherent guidance that helps users find the relevant monorepo setup without reading unrelated sections.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.