Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build_nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ jobs:
with:
files: lcov.info
flags: ${{ inputs.package }}
token: ${{ secrets.CODECOV_TOKEN }}
env:
HAS_CODECOV: ${{ secrets.CODECOV_TOKEN != '' }}
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

- name: Sanity check benchmarks
run: cargo bench ${{ matrix.config.args }} --package ${{ inputs.package }} --no-run
4 changes: 4 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ on:
- pkgs/**
- docs/**
- .github/workflows/pages.yml
- pyproject.toml
- uv.lock
- README.md
- '**/README.md'
workflow_dispatch:

concurrency:
Expand Down
10 changes: 2 additions & 8 deletions .github/workflows/pkg_num.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,15 @@ name: "dash-num"
on:
workflow_dispatch:
push:
paths:
paths: &paths
- pkgs/num/**
- Cargo.lock
- Cargo.toml
- .github/workflows/pkg_num.yml
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
pull_request:
paths:
- pkgs/num/**
- Cargo.lock
- Cargo.toml
- .github/workflows/pkg_num.yml
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
paths: *paths

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down
15 changes: 2 additions & 13 deletions .github/workflows/pkg_p2p_core.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "dash-p2p-core"
on:
workflow_dispatch:
push:
paths:
paths: &paths
- pkgs/p2p_core/**
- pkgs/num/**
- pkgs/params/**
Expand All @@ -16,18 +16,7 @@ on:
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
pull_request:
paths:
- pkgs/p2p_core/**
- pkgs/num/**
- pkgs/params/**
- pkgs/primitives/**
- pkgs/script/**
- pkgs/types/**
- Cargo.lock
- Cargo.toml
- .github/workflows/pkg_p2p_core.yml
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
paths: *paths

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down
13 changes: 2 additions & 11 deletions .github/workflows/pkg_params.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "dash-params"
on:
workflow_dispatch:
push:
paths:
paths: &paths
- pkgs/params/**
- pkgs/num/**
- pkgs/primitives/**
Expand All @@ -14,16 +14,7 @@ on:
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
pull_request:
paths:
- pkgs/params/**
- pkgs/num/**
- pkgs/primitives/**
- pkgs/script/**
- Cargo.lock
- Cargo.toml
- .github/workflows/pkg_params.yml
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
paths: *paths

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down
12 changes: 2 additions & 10 deletions .github/workflows/pkg_pkc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "dash-pkc"
on:
workflow_dispatch:
push:
paths:
paths: &paths
- pkgs/pkc/**
- pkgs/num/**
- pkgs/types/**
Expand All @@ -13,15 +13,7 @@ on:
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
pull_request:
paths:
- pkgs/pkc/**
- pkgs/num/**
- pkgs/types/**
- Cargo.lock
- Cargo.toml
- .github/workflows/pkg_pkc.yml
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
paths: *paths

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down
11 changes: 2 additions & 9 deletions .github/workflows/pkg_pow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "dash-pow"
on:
workflow_dispatch:
push:
paths:
paths: &paths
- pkgs/pow/**
- pkgs/num/**
- Cargo.lock
Expand All @@ -12,14 +12,7 @@ on:
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
pull_request:
paths:
- pkgs/pow/**
- pkgs/num/**
- Cargo.lock
- Cargo.toml
- .github/workflows/pkg_pow.yml
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
paths: *paths

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down
13 changes: 2 additions & 11 deletions .github/workflows/pkg_primitives.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "dash-primitives"
on:
workflow_dispatch:
push:
paths:
paths: &paths
- pkgs/primitives/**
- pkgs/num/**
- pkgs/script/**
Expand All @@ -14,16 +14,7 @@ on:
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
pull_request:
paths:
- pkgs/primitives/**
- pkgs/num/**
- pkgs/script/**
- pkgs/types/**
- Cargo.lock
- Cargo.toml
- .github/workflows/pkg_primitives.yml
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
paths: *paths

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down
11 changes: 2 additions & 9 deletions .github/workflows/pkg_script.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "dash-script"
on:
workflow_dispatch:
push:
paths:
paths: &paths
- pkgs/script/**
- pkgs/types/**
- Cargo.lock
Expand All @@ -12,14 +12,7 @@ on:
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
pull_request:
paths:
- pkgs/script/**
- pkgs/types/**
- Cargo.lock
- Cargo.toml
- .github/workflows/pkg_script.yml
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
paths: *paths

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down
10 changes: 2 additions & 8 deletions .github/workflows/pkg_types.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,15 @@ name: "dash-types"
on:
workflow_dispatch:
push:
paths:
paths: &paths
- pkgs/types/**
- Cargo.lock
- Cargo.toml
- .github/workflows/pkg_types.yml
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
pull_request:
paths:
- pkgs/types/**
- Cargo.lock
- Cargo.toml
- .github/workflows/pkg_types.yml
- .github/workflows/build_stable.yml
- .github/workflows/build_nightly.yml
paths: *paths

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down
21 changes: 20 additions & 1 deletion docs/dev/about_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ outside `docs/` resolve to the forge instead.

> [!WARNING]
> Zensical treats on-disk `.md` links as documentation and will fail to build if they are located outside `docs/`.
> This does not affect non-Markdown files and directories.
> This does not affect non-Markdown files and directories. [Omitted](#omitting) segments are not processed at all.

### Splicing

Expand All @@ -99,6 +99,10 @@ To splice in a whole document, or a spliced segment of it (like `setup`), the sy
<!-- [include:contrib/README.md:setup] -->
```

> [!WARNING]
> `omit` is a reserved label for _stripping_ spliceable regions from the final document. See [Omitting](#omitting) for
> more details.

To create a spliceable segment, wrap the desired text in `start` and `end` markers carrying its label (like `setup`).

```markdown
Expand All @@ -110,6 +114,21 @@ Carried into the splice.
Links in spliced material are resolved against the file that defines them, not the page splicing it in (see
[link processing](#link-processing)). Splices may nest, and a directive inside a code fence is inert.

### Omitting

Due to the dual-audience nature of our documentation, there may exist segments that are meant for GitHub but not
Zensical. The usual pattern for the reverse is to create a new file and then splice in what is required but this creates
situations where most of the file is included _except_ for a small portion. Omissions can take care of that.

To omit a segment, use the following syntax. Unlike other labels, `omit` can be used repeatedly but typos of `omit` will
be treated as ordinary spliceable segments.

```markdown
<!-- [start:omit] -->
Rendered on GitHub, absent from the site.
<!-- [end:omit] -->
```

## Postprocessing

> [!WARNING]
Expand Down
7 changes: 7 additions & 0 deletions docs/dev/maintenance.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Maintenance

<!-- [start:omit] -->

> [!NOTE]
> This is a spliced page meant for publication on Zensical. See [`maint`](../../maint/) for available documentation.

<!-- [end:omit] -->

<!-- [include:maint/README.md] -->
<!-- [include:contrib/README.md:bisect] -->
Loading
Loading