docs(thermidor): add ADR for simplified internal folder structure#7917
Conversation
|
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
There was a problem hiding this comment.
Pull request overview
Adds a new ADR (ADR-006) and two annexes documenting a proposed simplification of Thermidor’s internal src/ folder structure, including rationale, migration steps, and an example ESLint import-boundary enforcement approach.
Changes:
- Add ADR-006 describing the move to a
public/+internal/layout with barrel exports and lint-enforced boundaries. - Add Annex A with the full proposed directory tree, barrel examples, and an example
no-restricted-importsrule + import mapping. - Add Annex B cataloging the
core/interface/indirection layers that would be removed/merged under the proposed structure.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/thermidor/docs/internal/adr/ADR-006-simplified-folder-structure.md | Introduces the ADR decision, rationale, requirements mapping, and rollout plan for the simplified folder structure. |
| packages/thermidor/docs/internal/adr/ADR-006-annex-a-proposed-structure.md | Provides the full proposed directory tree plus barrel and ESLint rule examples. |
| packages/thermidor/docs/internal/adr/ADR-006-annex-b-removed-indirection.md | Details which indirection patterns/files would be removed or merged, and why. |
@coveo/atomic
@coveo/atomic-hosted-page
@coveo/atomic-legacy
@coveo/atomic-react
@coveo/auth
@coveo/bueno
@coveo/create-atomic
@coveo/create-atomic-component
@coveo/create-atomic-component-project
@coveo/create-atomic-result-component
@coveo/create-atomic-rollup-plugin
@coveo/headless
@coveo/headless-react
@coveo/shopify
commit: |
louis-bompart
left a comment
There was a problem hiding this comment.
LGTM. Some ideas
- Should we add README.md or other markdown file where we put
index.tsto:- Explains what's this folder does
- List the various file
I am thinking that having a "markdown" tree that follow the architecture could help agent follows and load only what's needed
Co-authored-by: fbeaudoincoveo <23503066+fbeaudoincoveo@users.noreply.github.com>
https://coveord.atlassian.net/browse/KIT-5773