docs/.github/sync-sources.yml at develop · tracebloc/docs · 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
# Mapping: upstream source files → docs pages
#
# Add a new source by appending an entry. The `id` is also used in the
# source repo's notify workflow (see .github/notify-docs.workflow-template.yml)
# to tell this repo which mapping changed.
#
# Fields:
#   id          unique slug for this mapping
#   repo        owner/name of the upstream repo
#   ref         branch or tag to read from
#   src         file path inside the upstream repo
#   dest        path in this repo (must exist)
#   private     true if the repo is private (requires SOURCE_REPOS_TOKEN)
#   instruction natural-language brief Claude follows when updating dest

sources:
  - id: tracebloc-package
    repo: tracebloc/tracebloc-py-package
    ref: develop
    src: README.md
    dest: tools-help/tracebloc.mdx
    private: true
    instruction: |
      Sync the Installation, Key Features, and Quick Start sections to reflect
      the upstream README. Preserve the page frontmatter and any prose that is
      unique to the docs page (e.g. links to other Mintlify pages).

  - id: client-setup
    repo: tracebloc/client
    ref: main
    src: README.md
    dest: environment-setup/setup-guide.mdx
    private: false
    instruction: |
      Sync installer steps, requirements, supported platforms, and verification
      commands. Preserve the page's narrative framing (numbered top-level steps,
      requirements table) and any prose unique to the docs page.

  - id: start-training
    repo: tracebloc/start-training
    ref: main
    src: README.md
    dest: join-use-case/start-training.mdx
    private: false
    instruction: |
      Sync notebook setup and the steps for launching experiments to match the
      upstream README. Preserve cross-links to other Join-a-Use-Case pages.

  - id: data-ingestors
    repo: tracebloc/data-ingestors
    ref: main
    src: Readme.md
    dest: create-use-case/prepare-dataset.mdx
    private: false
    instruction: |
      Sync dataset preparation pipeline steps, supported formats, and ingestor
      configuration from the upstream README. Preserve the page frontmatter and
      any examples specific to the docs page.

  - id: model-zoo
    repo: tracebloc/model-zoo
    ref: main
    src: README.md
    dest: create-use-case/templates.mdx
    private: false
    instruction: |
      Sync the list of available model templates and their descriptions from the
      upstream README. Preserve the page frontmatter and any prose specific to
      the docs page.