documentation icon indicating copy to clipboard operation
documentation copied to clipboard

DISCOVERY: Restructure doc (basely)

Open azinit opened this issue 2 years ago • 3 comments

@azinit: Decompose if needed!

Description

  • [x] S1 Research and impl draft solution
  • [x] S1 Decompose task
  • [x] S2 Get feedback about draft
  • [x] S2 Get feedback about popular pages from metrics
  • [ ] S2 Iterate by tasks:
    • [x] #332
    • [x] #320
    • [x] #321
    • [x] #322
    • [x] #323
    • [x] #324
    • [x] #334
  • [ ] Additional tasks:
    • [x] #446
    • [ ] #447
Steps
  • Swap specific articles
  • Merge/Split specific articles
  • Update redirects
  • Update reference links (Index-page, instead of concrete pages)
    • Remove old cross-linking to sections
  • Update both locales (ru, en)
  • (Basely) Refine intro
    • NavPointers (title, emojii, links)
  • Check cross-pagination
  • Reorder some items if needed (e.g. - concepts by difficulty)
  • Group some items if needed (promo & history & mission ...)
  • (Maybe) Add old decompose view for compatability
  • Add redirect page map (for old users)

TODO

Legend:

  • 🚀 TUTORIAL (get started)
  • 🛠 GUIDE (guides & examples)
  • 🧩 EXPLANATION (concepts)
  • 📚 UNDERSTANDING (reference)
  • 🍰 ABOUT
  • ~~🚀 int/Promotion at company => 🍰 /promo/Promotion at company~~
  • ~~🚀 int/Integration at team, 🚀 int/Partial application => 🍰 /promo/Integration at team~~
  • ~~🚀 int/Cheatsheet, 🚀 Decompose logic => 🚀 Cheatsheet~~
  • ~~🚀 int/Adv & Disadv => 🍰 /Adv & Disadv~~
  • ~~🚀 tut/Decompose logic, 🚀 tut/Decompose design layouts => 🚀 Decomposing logic~~
  • ~~🚀 tut/QuickStart => 🚀 QuickStart~~
  • ~~🚀 Alternatives/* => 🍰 /Alternatives/*~~
  • ~~🚀 Motivation => 🚀 Motivation (basely), 🍰 Motivation (completely)~~
  • 🧩 Needs-driven => 🧩Domain-first, 🧩Needs-driven
  • 🧩 Naming adaptivity => 🧩Naming
  • 🧩 App splitting => 🧩Decomposition
  • ~~🛠 Decouple entities => 🧩 Decouple entities (FIXME)~~
  • ~~🛠 Low Coupling & High Cohesion => 🧩 Isolation~~
  • ~~🛠 /White-labels =>🛠 /examples/White-labels~~
  • ~~🛠 /Monorepo =>🛠 /examples/Monorepo~~
  • ~~🛠 Handbook/* => 🧩 Handbook/* (TODO: and change name)~~
  • ~~🍰 Community, 🍰 Team => 🍰 Team~~

azinit avatar Oct 17 '21 15:10 azinit

@unordinarity Если есть возможность - глянь пож реструктуризацию статей по описанию, есть ли что поправить?

azinit avatar Oct 27 '21 07:10 azinit

@unordinarity Пингую опять, т.к. на выхах оч вероятно, что уже буду реструктурировать

azinit avatar Oct 29 '21 15:10 azinit

Хотя уже понятно, что в процессе придется щас перелопатить чутка реструктуризацию 🤔

azinit avatar Oct 30 '21 09:10 azinit