Skip to content

docs: shared settings as a table, show exported defaults in example - #29

Merged
iacoware merged 1 commit into
mainfrom
iacoware/settings-table-docs
Oct 29, 2026
Merged

iacoware merged 1 commit into
mainfrom
iacoware/settings-table-docs

Conversation

@iacoware

Copy link
Copy Markdown
Contributor

Summary

docs/user-guide/shared-settings.md:

 ## The settings
-- **`entryFiles`**: … used by: … default: …   (nested bullet lists)
+| Setting | Default | Used by |          (one row per setting)
+notes: index.ts excluded, how testFiles affects the three non-skipping rules, src/testing/
 ## Setting a value
+text names defaultEntryFiles / defaultTestFiles / defaultDiscriminants; JSON copies from the table
 ts example
+  testFiles: [...defaultTestFiles, "e2e/**"]
 json example
+  "testFiles": [<defaults copied>, "e2e/**"]

Evidence

  • Before: the defaults were sitting deep in nested bullets, and the exported defaults were mentioned only after the examples.
    After: pnpm build-and-pack: consumer test passed; cd website && pnpm test: 57 pass, 0 fail.

Merge Danger

Door: two-way

Blast Radius: docs

A wide Used by cell for testFiles may scroll horizontally on mobile.

🤖 Generated with Claude Code

https://claude.ai/code/session_019G1WFhcVfUMgQtuvhbacGc

…g example extends testFiles with the exported default, so defaultEntryFiles, defaultTestFiles and defaultDiscriminants are visible where a value replaces its default
@iacoware
iacoware merged commit 59e191f into main Oct 29, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant