docs: sync three docs from fiber main repo#38
docs: sync three docs from fiber main repo#38digi-monkey wants to merge 1 commit intonervosnetwork:masterfrom
Conversation
- Add glossary.md: Fiber Network terminology explanations - Add biscuit-auth.md: Biscuit authentication setup and usage guide - Add payment-lifecycle.md: Payment session and attempt state machine All links to fiber main repo code files are updated to absolute GitHub URLs. Navigation updated in meta.json to include new docs.
|
Someone is attempting to deploy a commit to the cryptape Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This pull request syncs three documentation files from the main Fiber repository to the documentation site. The PR adds comprehensive documentation covering Fiber Network terminology, Biscuit authentication implementation, and payment lifecycle state machines.
Changes:
- Added glossary.mdx with plain-language explanations of 13 key Fiber Network terms
- Added biscuit-auth.mdx documenting the Biscuit token-based authentication system used in Fiber RPC
- Added payment-lifecycle.mdx with a Mermaid diagram visualizing PaymentSession and PaymentAttempt state transitions
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| content/docs/guide/glossary.mdx | New glossary providing non-technical explanations of Fiber Network terminology including channels, HTLCs, routing, and watchtowers |
| content/docs/guide/biscuit-auth.mdx | New comprehensive guide covering Biscuit authentication configuration, token generation, RPC rules, and test examples with absolute GitHub links |
| content/docs/tech-explanation/payment-lifecycle.mdx | New technical document with Mermaid flowchart illustrating payment session and attempt state machines |
| content/docs/meta.json | Updated navigation to include the three new documentation pages in Guide and Tech Explanation sections |
Comments suppressed due to low confidence (2)
content/docs/guide/biscuit-auth.mdx:11
- Grammar issue: "is listen to" should be "is listening to". The phrase appears twice in this sentence and should be corrected to "it can be disabled when RPC is listening to a private address, but must be enabled when listening to a public address."
Biscuit is integrated into the Fiber RPC, it can be disabled when RPC is listen to private addr, but must be enabled when listen to public address. When enabled, it protects RPC endpoints by requiring a valid Biscuit token with permission for resources.
content/docs/guide/biscuit-auth.mdx:37
- The comment "// Cch" is unclear and should be expanded to explain what "Cch" stands for. Based on the context and the function names below (send_btc, receive_btc, get_cch_order), this appears to refer to "Cross-chain hub". Consider changing this to "// Cross-chain hub (Cch)" or simply "// Cross-chain hub" for better clarity and consistency with other section comments in this code block.
// Cch
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,45 @@ | |||
| # Fiber Network Glossary | |||
There was a problem hiding this comment.
This file is missing required frontmatter metadata. Based on the schema defined in source.config.ts and the convention followed by all other documentation files in this repository, this file should include frontmatter with at least a title and date field. Add a frontmatter section at the top of the file similar to other documentation files.
| @@ -0,0 +1,250 @@ | |||
| # Biscuit Authentication in Fiber | |||
There was a problem hiding this comment.
This file is missing required frontmatter metadata. Based on the schema defined in source.config.ts and the convention followed by all other documentation files in this repository, this file should include frontmatter with at least a title and date field. Add a frontmatter section at the top of the file similar to other documentation files.
| @@ -0,0 +1,37 @@ | |||
| # Fiber Payment Lifecycle | |||
There was a problem hiding this comment.
This file is missing required frontmatter metadata. Based on the schema defined in source.config.ts and the convention followed by all other documentation files in this repository, this file should include frontmatter with at least a title and date field. Add a frontmatter section at the top of the file similar to other documentation files.
All links to fiber main repo code files are updated to absolute GitHub URLs. Navigation updated in meta.json to include new docs.