Skip to content

Commit ce8a5dd

Browse files
GlittersupGlittersup
authored
Merge pull request #25 from Komelove/entrypoint
docs: add withdraw_amount, locked, and progress entry points
2 parents ba16b4c + c81498f commit ce8a5dd

13 files changed

Lines changed: 1138 additions & 1114 deletions

‎.github/CODEOWNERS‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Every file in this repository is reviewed by the maintainers. Ownership is
2-
# held by the team rather than by individuals, so review does not depend on any
3-
# one person being available.
4-
* @TricklePay/maintainers
1+
# Every file in this repository is reviewed by the maintainers. Ownership is
2+
# held by the team rather than by individuals, so review does not depend on any
3+
# one person being available.
4+
* @TricklePay/maintainers

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
blank_issues_enabled: true
2-
contact_links:
3-
- name: Report a security vulnerability
4-
url: https://github.com/TricklePay/docs/blob/main/SECURITY.md
5-
about: >
6-
Do not open a public issue. Report it privately on the affected
7-
repository, as described in the security policy.
8-
9-
- name: Bug in the contract, backend, or frontend
10-
url: https://github.com/TricklePay
11-
about: >
12-
This repository holds documentation only. Open code issues on the
13-
repository they affect.
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Report a security vulnerability
4+
url: https://github.com/TricklePay/docs/blob/main/SECURITY.md
5+
about: >
6+
Do not open a public issue. Report it privately on the affected
7+
repository, as described in the security policy.
8+
9+
- name: Bug in the contract, backend, or frontend
10+
url: https://github.com/TricklePay
11+
about: >
12+
This repository holds documentation only. Open code issues on the
13+
repository they affect.

‎.github/ISSUE_TEMPLATE/documentation-issue.yml‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
name: Documentation issue
2-
description: Something in the docs is wrong, out of date, broken, or unclear.
3-
labels: [documentation]
4-
body:
5-
- type: input
6-
id: page
7-
attributes:
8-
label: Page
9-
description: The file, and the heading or line if you have it.
10-
placeholder: ARCHITECTURE.md, "Vesting model"
11-
validations:
12-
required: true
13-
14-
- type: textarea
15-
id: problem
16-
attributes:
17-
label: What is wrong
18-
description: Quote the passage if it is short.
19-
validations:
20-
required: true
21-
22-
- type: textarea
23-
id: expected
24-
attributes:
25-
label: What it should say
26-
description: >
27-
If the docs disagree with the code, say which repository and file you
28-
checked against. The contract is the source of truth.
29-
validations:
30-
required: true
1+
name: Documentation issue
2+
description: Something in the docs is wrong, out of date, broken, or unclear.
3+
labels: [documentation]
4+
body:
5+
- type: input
6+
id: page
7+
attributes:
8+
label: Page
9+
description: The file, and the heading or line if you have it.
10+
placeholder: ARCHITECTURE.md, "Vesting model"
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: problem
16+
attributes:
17+
label: What is wrong
18+
description: Quote the passage if it is short.
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: expected
24+
attributes:
25+
label: What it should say
26+
description: >
27+
If the docs disagree with the code, say which repository and file you
28+
checked against. The contract is the source of truth.
29+
validations:
30+
required: true

‎.github/ISSUE_TEMPLATE/documentation-request.yml‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
name: Documentation request
2-
description: Something is missing from the docs and should be written.
3-
labels: [documentation]
4-
body:
5-
- type: textarea
6-
id: missing
7-
attributes:
8-
label: What is missing
9-
description: What you went looking for and could not find.
10-
validations:
11-
required: true
12-
13-
- type: textarea
14-
id: audience
15-
attributes:
16-
label: Who needs it
17-
description: >
18-
A contributor to the contract, someone integrating with the API, an
19-
auditor reading the threat model, and so on. This decides where it goes.
20-
validations:
21-
required: true
22-
23-
- type: input
24-
id: location
25-
attributes:
26-
label: Where it belongs
27-
description: The existing file it fits into, if you have a view.
28-
placeholder: CONTRIBUTING.md
1+
name: Documentation request
2+
description: Something is missing from the docs and should be written.
3+
labels: [documentation]
4+
body:
5+
- type: textarea
6+
id: missing
7+
attributes:
8+
label: What is missing
9+
description: What you went looking for and could not find.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: audience
15+
attributes:
16+
label: Who needs it
17+
description: >
18+
A contributor to the contract, someone integrating with the API, an
19+
auditor reading the threat model, and so on. This decides where it goes.
20+
validations:
21+
required: true
22+
23+
- type: input
24+
id: location
25+
attributes:
26+
label: Where it belongs
27+
description: The existing file it fits into, if you have a view.
28+
placeholder: CONTRIBUTING.md

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1-
# What changed
2-
3-
<!-- What this pull request changes, and why it is needed. -->
4-
5-
Closes #
6-
7-
# How it was verified
8-
9-
<!--
10-
How you checked the change is correct. For docs, this usually means naming the
11-
code you read to confirm a claim: the contract is the source of truth, and the
12-
backend and frontend must agree with it.
13-
-->
14-
15-
# Checklist
16-
17-
- [ ] `./scripts/check-links.sh` passes locally.
18-
- [ ] `markdownlint "**/*.md" --ignore node_modules` passes locally.
19-
- [ ] `cspell --config cspell.json "**/*.md"` passes locally (add new technical terms to `.cspell/project-words.txt` if needed).
20-
- [ ] Claims about behavior match the code in the repository they describe.
21-
- [ ] The vesting model is described consistently wherever it appears.
22-
- [ ] No addresses, keys, contract ids, or endpoints that should stay private.
1+
# What changed
2+
3+
<!-- What this pull request changes, and why it is needed. -->
4+
5+
Closes #
6+
7+
# How it was verified
8+
9+
<!--
10+
How you checked the change is correct. For docs, this usually means naming the
11+
code you read to confirm a claim: the contract is the source of truth, and the
12+
backend and frontend must agree with it.
13+
-->
14+
15+
# Checklist
16+
17+
- [ ] `./scripts/check-links.sh` passes locally.
18+
- [ ] Claims about behavior match the code in the repository they describe.
19+
- [ ] The vesting model is described consistently wherever it appears.
20+
- [ ] No addresses, keys, contract ids, or endpoints that should stay private.

‎.github/workflows/ci.yml‎

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
1-
name: CI
2-
3-
on:
4-
push:
5-
branches: [main]
6-
pull_request:
7-
8-
jobs:
9-
links:
10-
runs-on: ubuntu-latest
11-
steps:
12-
- uses: actions/checkout@v4
13-
14-
- run: ./scripts/check-links.sh
15-
16-
markdownlint:
17-
runs-on: ubuntu-latest
18-
steps:
19-
- uses: actions/checkout@v4
20-
21-
- name: Set up Node.js
22-
uses: actions/setup-node@v4
23-
with:
24-
node-version: "20"
25-
26-
- name: Install markdownlint-cli
27-
run: npm install --global markdownlint-cli@0.44.0
28-
29-
- name: Lint markdown files
30-
run: markdownlint "**/*.md" --ignore node_modules
31-
32-
spellcheck:
33-
runs-on: ubuntu-latest
34-
steps:
35-
- uses: actions/checkout@v4
36-
37-
- name: Set up Node.js
38-
uses: actions/setup-node@v4
39-
with:
40-
node-version: "20"
41-
42-
- name: Install cspell
43-
run: npm install --global cspell@8.20.0
44-
45-
- name: Spell-check markdown files
46-
run: cspell --config cspell.json "**/*.md"
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
8+
jobs:
9+
links:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- run: ./scripts/check-links.sh
15+
16+
markdownlint:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v4
20+
21+
- name: Set up Node.js
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: "20"
25+
26+
- name: Install markdownlint-cli
27+
run: npm install --global markdownlint-cli@0.44.0
28+
29+
- name: Lint markdown files
30+
run: markdownlint "**/*.md" --ignore node_modules
31+
32+
spellcheck:
33+
runs-on: ubuntu-latest
34+
steps:
35+
- uses: actions/checkout@v4
36+
37+
- name: Set up Node.js
38+
uses: actions/setup-node@v4
39+
with:
40+
node-version: "20"
41+
42+
- name: Install cspell
43+
run: npm install --global cspell@8.20.0
44+
45+
- name: Spell-check markdown files
46+
run: cspell --config cspell.json "**/*.md"

0 commit comments

Comments
 (0)