From 16c2e8ea9916ab96589fbd4bc1b6bb506c0f021b Mon Sep 17 00:00:00 2001 From: Vadim Zolotokrylin Date: Thu, 23 Apr 2026 12:57:26 +0800 Subject: [PATCH 1/2] docs(contributing): keep docs interlinked and avoid content duplication --- docs/CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 7e93cb0..dd909bb 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -203,6 +203,10 @@ When introducing functional changes, cross-check the README and update it in the same PR. If your change affects anything documented there — setup steps, environment requirements, file references — the README must stay in sync. +When adding new documentation files, ensure they are reachable via interlinking from the root entry point. Do not create orphaned files. + +Do not duplicate content across files. Each piece of information — procedures, templates, configuration steps — must live in exactly one place. Reference it from other docs rather than copying it. + ### Naming > [!NOTE] From 7f32c9dc9333459491ba51644ff29a0c9772ec39 Mon Sep 17 00:00:00 2001 From: Vadim Zolotokrylin Date: Thu, 23 Apr 2026 12:59:24 +0800 Subject: [PATCH 2/2] fix: markdown formatting --- docs/CONTRIBUTING.md | 16 +++++++++++----- docs/REFERRAL.md | 6 +++--- docs/TRIAL.md | 3 ++- 3 files changed, 16 insertions(+), 9 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index dd909bb..d3ffc29 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -187,7 +187,8 @@ For detailed instructions on why and how to sign your commits refer to ### Scoping > [!TIP] -> Here's a [good resource](https://youtu.be/bmSAYlu0NcY?si=2lLQeY1PGCY9tcvX) on software design philosophy. +> Here's a [good resource](https://youtu.be/bmSAYlu0NcY?si=2lLQeY1PGCY9tcvX) on +> software design philosophy. When planning the scope of work, make sure you [keep PRs small](https://artsy.github.io/blog/2021/03/09/strategies-for-small-focused-pull-requests/). @@ -203,9 +204,12 @@ When introducing functional changes, cross-check the README and update it in the same PR. If your change affects anything documented there — setup steps, environment requirements, file references — the README must stay in sync. -When adding new documentation files, ensure they are reachable via interlinking from the root entry point. Do not create orphaned files. +When adding new documentation files, ensure they are reachable via interlinking +from the root entry point. Do not create orphaned files. -Do not duplicate content across files. Each piece of information — procedures, templates, configuration steps — must live in exactly one place. Reference it from other docs rather than copying it. +Do not duplicate content across files. Each piece of information — procedures, +templates, configuration steps — must live in exactly one place. Reference it +from other docs rather than copying it. ### Naming @@ -254,7 +258,8 @@ _"What am I building?"_ #### Design PRs -Design PRs use `docs(ui)` as the type and scope. e.g.: `docs(ui): design table component` +Design PRs use `docs(ui)` as the type and scope. e.g.: +`docs(ui): design table component` Initiate a PR with a note in the DESIGN.md file detailing the addressed design aspects. Structure the design file with the following markup: @@ -286,7 +291,8 @@ Example: - [[Bid Popup]](https://figma.com/your-design-file-url) ``` -If there isn't an existing DESIGN.md file, create one and link it from README.md. +If there isn't an existing DESIGN.md file, create one and link it from +README.md. ### PR Lifecycle diff --git a/docs/REFERRAL.md b/docs/REFERRAL.md index 9256a80..ee65658 100644 --- a/docs/REFERRAL.md +++ b/docs/REFERRAL.md @@ -14,6 +14,6 @@ Once the eligibility conditions are met, reach out to your lead to claim the reward. > [!IMPORTANT] -> This referral program applies unless there is a separate commercial -> engagement between Holdex and the contributor, in which case referral terms -> are governed by that agreement instead. +> This referral program applies unless there is a separate commercial engagement +> between Holdex and the contributor, in which case referral terms are governed +> by that agreement instead. diff --git a/docs/TRIAL.md b/docs/TRIAL.md index 7168bad..84464db 100644 --- a/docs/TRIAL.md +++ b/docs/TRIAL.md @@ -59,7 +59,8 @@ trial and follow our team's principles. ## I don't have access to open a PR in the repository. What do I do? -Fork the repository and create a PR using a [Fork Strategy](https://gist.github.com/Chaser324/ce0505fbed06b947d962). +Fork the repository and create a PR using a +[Fork Strategy](https://gist.github.com/Chaser324/ce0505fbed06b947d962). ## What is the trial duration?