Skip to content

Commit fccdde4

Browse files
janechujanechu
committed
update declarative docs locations
1 parent e9c4e99 commit fccdde4

10 files changed

Lines changed: 15 additions & 15 deletions

File tree

‎packages/fast-build/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,5 +172,5 @@ All keys are optional. Only the following keys are allowed: `entry`, `state`, `o
172172
## Template syntax
173173

174174
Template syntax follows the FAST declarative HTML format. See the
175-
[`@microsoft/fast-element` declarative documentation](../fast-element/DECLARATIVE_HTML.md)
175+
[`@microsoft/fast-element` declarative documentation](https://fast.design/docs/3.x/declarative-templates/overview/)
176176
for full documentation on bindings, conditionals, repeats, and directives.

‎packages/fast-element/DESIGN.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ The `src/declarative/index.ts` entrypoint is pure at module evaluation time. Run
366366
declarative API lazily installs declarative debug messages only. Hydration hooks
367367
and hydratable `ViewTemplate` support are installed exclusively by
368368
`enableHydration()` from `@microsoft/fast-element/hydration.js`. See
369-
[`DECLARATIVE_DESIGN.md`](./DECLARATIVE_DESIGN.md) for the detailed
369+
[`declarative-design.md`](./docs/declarative-design.md) for the detailed
370370
architecture.
371371

372372
---
@@ -603,7 +603,7 @@ src/
603603
| [docs/architecture/fastelement.md](./docs/architecture/fastelement.md) | FASTElement & ElementController lifecycle in detail |
604604
| [docs/architecture/html-tagged-template-literal.md](./docs/architecture/html-tagged-template-literal.md) | `html` tag, directives, binding pre-processing |
605605
| [docs/architecture/updates.md](./docs/architecture/updates.md) | Updates queue, attribute and observable change batching |
606-
| [DECLARATIVE_DESIGN.md](./DECLARATIVE_DESIGN.md) | Declarative HTML runtime, parser, schema, maps, and fixture architecture |
606+
| [declarative-design.md](./docs/declarative-design.md) | Declarative HTML runtime, parser, schema, maps, and fixture architecture |
607607
| [docs/template-bindings.md](./docs/template-bindings.md) | Full template binding pipeline: authoring → compilation → binding → DOM updates |
608608
| [docs/fast-element-2-changes.md](./docs/fast-element-2-changes.md) | Breaking changes from v1 to v2 |
609609

‎packages/fast-element/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ mapping runs before observer mapping.
167167

168168
Declarative utilities such as `deepMerge` are available from
169169
`@microsoft/fast-element/declarative-utilities.js`. See
170-
[`DECLARATIVE_HTML.md`](./DECLARATIVE_HTML.md) for declarative implementation
170+
[`declarative-html.md`](./docs/declarative-html.md) for declarative implementation
171171
details and the
172172
[Declarative HTML docs](https://fast.design/docs/3.x/declarative-templates/overview/)
173173
for guides on writing f-templates, defining declarative elements, and

packages/fast-element/DECLARATIVE_DESIGN.md renamed to packages/fast-element/docs/declarative-design.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,7 @@ flowchart LR
557557

558558
For a deep dive into the schema structure, context tracking, and proxy system
559559
see
560-
[DECLARATIVE_SCHEMA_OBSERVER_MAP.md](./DECLARATIVE_SCHEMA_OBSERVER_MAP.md).
560+
[declarative-schema-observer-map.md](./declarative-schema-observer-map.md).
561561

562562
### `$observe` flag on schema nodes
563563

@@ -654,7 +654,7 @@ sequenceDiagram
654654
| `hydrationComplete()` | `enableHydration(options)` | Once, after all prerendered elements have completed hydration. |
655655

656656
For usage examples see
657-
[DECLARATIVE_RENDERING_LIFECYCLE.md](./DECLARATIVE_RENDERING_LIFECYCLE.md).
657+
[declarative-rendering-lifecycle.md](./declarative-rendering-lifecycle.md).
658658

659659
---
660660

@@ -720,7 +720,7 @@ With `declarativeTemplate()`, connection gating happens before platform registra
720720
```
721721

722722
For detailed examples see
723-
[DECLARATIVE_RENDERING.md](./DECLARATIVE_RENDERING.md).
723+
[declarative-rendering.md](./declarative-rendering.md).
724724

725725
---
726726

@@ -797,10 +797,10 @@ for an example of a complex multi-feature fixture.
797797

798798
| Document | Topic |
799799
|---|---|
800-
| [DECLARATIVE_HTML.md](./DECLARATIVE_HTML.md) | Installation, syntax reference, lifecycle callbacks, usage examples |
801-
| [DECLARATIVE_RENDERING.md](./DECLARATIVE_RENDERING.md) | Hydratable HTML format: comment markers, dataset attributes, directive markers |
802-
| [DECLARATIVE_RENDERING_LIFECYCLE.md](./DECLARATIVE_RENDERING_LIFECYCLE.md) | Phase-by-phase rendering lifecycle, callback ordering, performance notes |
803-
| [DECLARATIVE_SCHEMA_OBSERVER_MAP.md](./DECLARATIVE_SCHEMA_OBSERVER_MAP.md) | Deep dive into Schema JSON structure, ObserverMap proxy system, debugging |
800+
| [declarative-html.md](./declarative-html.md) | Installation, syntax reference, lifecycle callbacks, usage examples |
801+
| [declarative-rendering.md](./declarative-rendering.md) | Hydratable HTML format: comment markers, dataset attributes, directive markers |
802+
| [declarative-rendering-lifecycle.md](./declarative-rendering-lifecycle.md) | Phase-by-phase rendering lifecycle, callback ordering, performance notes |
803+
| [declarative-schema-observer-map.md](./declarative-schema-observer-map.md) | Deep dive into Schema JSON structure, ObserverMap proxy system, debugging |
804804
| [test/declarative/fixtures/README.md](./test/declarative/fixtures/README.md) | Quick reference for fixture structure |
805805
| [test/declarative/fixtures/WRITING_FIXTURES.md](./test/declarative/fixtures/WRITING_FIXTURES.md) | Complete guide to writing new Playwright fixture tests |
806806
| [test/declarative/fixtures/extensions/observer-map-deep-merge/README.md](./test/declarative/fixtures/extensions/observer-map-deep-merge/README.md) | Complex deep-merge fixture: observable arrays, nested repeats, conditionals |

packages/fast-element/DECLARATIVE_HTML.md renamed to packages/fast-element/docs/declarative-html.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ be stack agnostic because JavaScript does not need to be interpreted to emit
6060
the initial HTML. The declarative runtime expects hydratable comment markers
6161
and datasets when prerendered content is generated. For the required marker
6262
format and initial-state application details, see
63-
[DECLARATIVE_RENDERING.md](./DECLARATIVE_RENDERING.md).
63+
[declarative-rendering.md](./declarative-rendering.md).
6464

6565
## Lifecycle Callbacks
6666

@@ -467,4 +467,4 @@ rendering differences between `fast-build` and `webui`. The
467467
`playwright.declarative.webui.config.ts` file sets
468468
`FAST_WEBUI_INTEGRATION=true`, and affected tests use `test.skip()` with a
469469
descriptive reason. See the WebUI Integration Tests section in
470-
[DECLARATIVE_DESIGN.md](./DECLARATIVE_DESIGN.md) for the full list.
470+
[declarative-design.md](./declarative-design.md) for the full list.

packages/fast-element/DECLARATIVE_MIGRATION.md renamed to packages/fast-element/docs/declarative-migration.md

File renamed without changes.

packages/fast-element/DECLARATIVE_RENDERING_LIFECYCLE.md renamed to packages/fast-element/docs/declarative-rendering-lifecycle.md

File renamed without changes.

packages/fast-element/DECLARATIVE_RENDERING.md renamed to packages/fast-element/docs/declarative-rendering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -527,4 +527,4 @@ Should result in:
527527

528528
For information about the declarative rendering lifecycle inside
529529
`@microsoft/fast-element`, see
530-
[DECLARATIVE_RENDERING_LIFECYCLE.md](./DECLARATIVE_RENDERING_LIFECYCLE.md).
530+
[declarative-rendering-lifecycle.md](./declarative-rendering-lifecycle.md).

packages/fast-element/DECLARATIVE_SCHEMA_OBSERVER_MAP.md renamed to packages/fast-element/docs/declarative-schema-observer-map.md

File renamed without changes.

‎packages/fast-element/test/declarative/fixtures/WRITING_FIXTURES.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ This file defines the declarative `<f-template>` elements that describe each cus
150150

151151
For a full reference of binding syntax, event bindings, directives (`f-when`,
152152
`f-repeat`), and execution context access, see the [Syntax section of the
153-
declarative docs](../../../DECLARATIVE_HTML.md#syntax).
153+
declarative docs](../../../docs/declarative-html.md#syntax).
154154

155155
Multiple `<f-template>` elements can be defined in a single `templates.html` — one per custom element used in the fixture.
156156

0 commit comments

Comments
 (0)