pipeforge/docs-map.yaml at dev · devlive-community/pipeforge · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
#
# Copyright (c) 2026 devlive-community/pipeforge
#
# Licensed under the MIT License. See the LICENSE file in the
# project root for full license text.
#

# Code paths and the documentation pages that describe them (see the docs guide on the
# documentation site). A feat / perf / breaking commit that changes a mapped path must also
# change every listed page, in English and Chinese, or explain "Docs-Not-Needed: <reason>".
# Every new module must be registered here.
#
#   - paths: ["<glob>", ...]     repository-relative globs
#     docs: ["<page>", ...]      page ids relative to docs/content/<lang>/, without extension
#
# Entries are added together with the code they describe.

- paths: ["dev/**"]
  docs: ["development/local-environment"]
- paths: ["docs/app/**", "docs/components/**", "docs/lib/**", "docs/styles/**", "docs/scripts/**"]
  docs: ["development/docs-guide"]
- paths: ["pipeforge-design-tokens/**"]
  docs: ["development/docs-guide"]
# The error framework. New codes (ErrorCode constants and errors/*.yaml) only feed the generated
# reference/errors page and need no hand edits.
- paths:
    - "pipeforge-common/src/main/java/org/devlive/pipeforge/common/error/PipeForgeException.java"
    - "pipeforge-common/src/main/java/org/devlive/pipeforge/common/error/ErrorRegistry.java"
    - "pipeforge-common/src/main/java/org/devlive/pipeforge/common/error/ErrorDefinition.java"
    - "pipeforge-common/src/main/java/org/devlive/pipeforge/common/error/ErrorInfo.java"
    - "pipeforge-common/src/main/java/org/devlive/pipeforge/common/error/ErrorScope.java"
    - "pipeforge-common/src/main/java/org/devlive/pipeforge/common/error/ErrorKind.java"
    - "pipeforge-common/src/main/java/org/devlive/pipeforge/common/error/ErrorCategory.java"
    - "pipeforge-common/src/main/java/org/devlive/pipeforge/common/error/MessageTemplate.java"
  docs: ["concepts/errors"]
- paths: ["pipeforge-common/src/main/java/org/devlive/pipeforge/common/plugin/**"]
  docs: ["development/plugin-packaging"]
- paths: ["pipeforge-api/**"]
  docs: ["development/api-overview"]
- paths: ["pipeforge-api/src/main/java/org/devlive/pipeforge/api/row/**", "pipeforge-api/src/main/java/org/devlive/pipeforge/api/type/**", "pipeforge-api/src/main/java/org/devlive/pipeforge/api/table/**"]
  docs: ["concepts/data-model"]
- paths: ["pipeforge-maven-plugin/**"]
  docs: ["development/plugin-packaging"]
- paths: ["pipeforge-plugin/**"]
  docs: ["concepts/plugins"]
- paths: ["pipeforge-expressions/**"]
  docs: ["concepts/expressions", "reference/expression-syntax"]
- paths: ["pipeforge-core/src/main/java/org/devlive/pipeforge/core/job/**"]
  docs: ["reference/job-dsl"]
- paths: ["pipeforge-core/src/main/java/org/devlive/pipeforge/core/variable/**"]
  docs: ["reference/variables"]
- paths: ["pipeforge-core/src/main/java/org/devlive/pipeforge/core/plan/**", "pipeforge-core/src/main/java/org/devlive/pipeforge/core/explain/**"]
  docs: ["concepts/plan-and-explain"]
- paths: ["pipeforge-core/src/main/java/org/devlive/pipeforge/core/expression/**"]
  docs: ["development/api-overview", "concepts/expressions"]
# The native engine. In local mode the runtime is described by the execution concept page.
- paths: ["pipeforge-engine/**"]
  docs: ["concepts/execution"]
- paths: ["pipeforge-connector-testkit/**"]
  docs: ["development/testkit"]
# Plugins: every plugin module has its page; the conventions of plugin builds are part of packaging.
- paths: ["pipeforge-connectors/pom.xml"]
  docs: ["development/plugin-packaging"]
- paths: ["pipeforge-connectors/connector-fake/**"]
  docs: ["plugins/source/fake"]
- paths: ["pipeforge-connectors/transform-field-mapper/**"]
  docs: ["plugins/transform/field-mapper", "reference/mapping"]
- paths: ["pipeforge-server/**"]
  docs: ["operations/server"]
- paths: ["pipeforge-server/openapi.json", "pipeforge-server/src/main/java/org/devlive/pipeforge/server/api/**"]
  docs: ["reference/api"]
- paths: ["pipeforge-client-ts/**"]
  docs: ["reference/api"]
# The Web UI: every page has a guide in guides/; the component library and the tooling are
# described in development/ui-guide. Features register their own src/features/<feature>/** entry.
- paths: ["pipeforge-ui/src/ui/**", "pipeforge-ui/src/canvas/**", "pipeforge-ui/src/styles/**", "pipeforge-ui/scripts/**", "pipeforge-ui/e2e/**", "pipeforge-ui/package.json"]
  docs: ["development/ui-guide"]
- paths: ["pipeforge-ui/src/app/**", "pipeforge-ui/src/features/overview/**", "pipeforge-ui/src/features/not-found/**"]
  docs: ["guides/web-ui"]
- paths: ["pipeforge-ui/src/features/job-editor/**"]
  docs: ["guides/job-editor"]
- paths: ["pipeforge-ui/src/features/plugins/**"]
  docs: ["guides/plugins"]
- paths: ["pipeforge-ui/src/features/functions/**"]
  docs: ["guides/functions"]
- paths: ["pipeforge-ui/src/features/errors/**"]
  docs: ["guides/error-codes"]