Skip to content

Commit d2babe7

Browse files
josecelanojosecelano
committed
docs(frontmatter): add YAML frontmatter and semantic links to all docs/ Markdown files (torrust#1810)
Add YAML frontmatter with semantic-links to all 67 docs/ Markdown files that previously lacked it, following the convention defined in docs/skills/semantic-skill-link-convention.md. Changes: - Top-level docs/ files (7): AGENTS.md, benchmarking.md, containers.md, index.md, packages.md, profiling.md, release_process.md - docs/adrs/ files (7): 5 ADR files + README.md + index.md - docs/issues/ nav files (4): README.md + closed/open/drafts READMEs - docs/issues/closed/ specs (31): 523, 669, 671, 672, 1525-1563, 1582 group, 1697-1723 group, 1732 group, 1740-1750 group - docs/issues/open/ supplementary files (4): 1669 sub-docs + 1726 ISSUE.md and benchmark-results.md - docs/pr-reviews/ files (2): README.md + pr-1733 tracking doc - docs/refactor-plans/ files (5): closed/open/drafts READMEs + 2 plan files - docs/skills/semantic-skill-link-convention.md (1): add frontmatter + clarify that frontmatter skill-links supersede inline top-of-file markers (T15) Bidirectional related-artifacts links applied between all cross-referenced docs/ files. docs/index.md updated with back-refs to newly processed nav files. Closes torrust#1810
1 parent 42df29c commit d2babe7

68 files changed

Lines changed: 1098 additions & 136 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/AGENTS.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
semantic-links:
3+
skill-links:
4+
- write-markdown-docs
5+
related-artifacts:
6+
- docs/index.md
7+
- docs/skills/semantic-skill-link-convention.md
8+
---
9+
110
# `docs/` — Documentation Directory
211

312
This directory contains all project documentation: operational guides, architectural decision

‎docs/adrs/20240227164834_use_plural_for_modules_containing_collections.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
semantic-links:
3+
skill-links:
4+
- create-adr
5+
related-artifacts:
6+
- .github/skills/dev/planning/create-adr/SKILL.md
7+
- src/
8+
---
9+
110
# Use plural for modules containing collections of types
211

312
## Description

‎docs/adrs/20260420200013_adopt_custom_github_copilot_aligned_agent_framework.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
---
2+
semantic-links:
3+
skill-links:
4+
- create-adr
5+
related-artifacts:
6+
- .github/skills/dev/planning/create-adr/SKILL.md
7+
- AGENTS.md
8+
- .github/skills/
9+
- .github/agents/
10+
---
11+
112
# Adopt a Custom, GitHub-Copilot-Aligned Agent Framework
213

314
## Description

‎docs/adrs/20260429000000_keep_database_as_aggregate_supertrait.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
semantic-links:
3+
skill-links:
4+
- create-adr
5+
related-artifacts:
6+
- .github/skills/dev/planning/create-adr/SKILL.md
7+
- docs/packages.md
8+
- packages/tracker-core/
9+
---
10+
111
# Keep `Database` as an Aggregate Supertrait
212

313
## Description

‎docs/adrs/20260512102000_define_tracker_client_peer_id_convention.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
---
2+
semantic-links:
3+
skill-links:
4+
- create-adr
5+
related-artifacts:
6+
- .github/skills/dev/planning/create-adr/SKILL.md
7+
- packages/peer-id/
8+
- packages/tracker-client/
9+
- console/tracker-client/
10+
---
11+
112
# Define Tracker-Client Peer ID Convention
213

314
## Description

‎docs/adrs/20260519000000_define_global_cli_output_contract.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
---
2+
semantic-links:
3+
skill-links:
4+
- create-adr
5+
related-artifacts:
6+
- .github/skills/dev/planning/create-adr/SKILL.md
7+
- src/main.rs
8+
- src/bin/
9+
- console/tracker-client/
10+
---
11+
112
# Define the Global CLI Output Contract
213

314
## Description

‎docs/adrs/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
semantic-links:
3+
skill-links:
4+
- create-adr
5+
related-artifacts:
6+
- docs/index.md
7+
- docs/adrs/index.md
8+
- .github/skills/dev/planning/create-adr/SKILL.md
9+
---
10+
111
# Architectural Decision Records (ADRs)
212

313
This directory contains the architectural decision records (ADRs) for the project.

‎docs/adrs/index.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
semantic-links:
3+
skill-links:
4+
- create-adr
5+
related-artifacts:
6+
- docs/index.md
7+
- docs/adrs/README.md
8+
---
9+
110
# ADR Index
211

312
| ADR | Date | Title | Short Description |

‎docs/benchmarking.md‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
---
2+
semantic-links:
3+
skill-links:
4+
- write-markdown-docs
5+
related-artifacts:
6+
- docs/index.md
7+
- docs/profiling.md
8+
- packages/torrent-repository-benchmarking/
9+
- share/default/config/tracker.udp.benchmarking.toml
10+
---
11+
112
# Benchmarking
213

314
We have two types of benchmarking:
@@ -211,11 +222,11 @@ Announce responses per info hash:
211222

212223
Announce request per second:
213224

214-
| Tracker | Announce |
215-
|---------------|-----------|
216-
| Aquatic | 192,817 |
217-
| Torrust | 177,508 |
218-
| Torrust-Actix | 89,539 |
225+
| Tracker | Announce |
226+
| ------------- | -------- |
227+
| Aquatic | 192,817 |
228+
| Torrust | 177,508 |
229+
| Torrust-Actix | 89,539 |
219230

220231
Using a PC with:
221232

@@ -244,7 +255,7 @@ You can run it with:
244255
cargo bench -p torrust-tracker-torrent-repository
245256
```
246257

247-
It tests the different implementations for the internal torrent storage. The output should be something like this:
258+
It tests the different implementations for the internal torrent storage. The output should be something like this:
248259

249260
```output
250261
Running benches/repository_benchmark.rs (target/release/deps/repository_benchmark-2f7830898bbdfba4)

‎docs/containers.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
semantic-links:
3+
skill-links:
4+
- write-markdown-docs
5+
related-artifacts:
6+
- docs/index.md
7+
- Containerfile
8+
- share/container/entry_script_sh
9+
---
10+
111
# Containers (Docker or Podman)
212

313
## Demo environment

0 commit comments

Comments
 (0)