Skip to content

docs: sync three docs from fiber main repo#38

Merged
HappySonnyDev merged 2 commits intonervosnetwork:masterfrom
digi-monkey:master
Mar 17, 2026
Merged

docs: sync three docs from fiber main repo#38
HappySonnyDev merged 2 commits intonervosnetwork:masterfrom
digi-monkey:master

Conversation

@digi-monkey
Copy link
Copy Markdown
Contributor

  • 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.

@vercel
Copy link
Copy Markdown

vercel bot commented Feb 18, 2026

Someone is attempting to deploy a commit to the cryptape Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link
Copy Markdown

vercel bot commented Feb 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
fiber-docs Ready Ready Preview, Comment Mar 17, 2026 5:47am

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
@@ -0,0 +1,250 @@
# Biscuit Authentication in Fiber
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
@@ -0,0 +1,37 @@
# Fiber Payment Lifecycle
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
@HappySonnyDev
Copy link
Copy Markdown
Collaborator

HappySonnyDev commented Mar 17, 2026

Hi @digi-monkey ,Thanks for your contribution! I noticed a few issues that need to be fixed before we can merge this PR.

Issues Found

  1. Missing Frontmatter
    The following MDX files are missing required YAML frontmatter (title and date):
    content/docs/guide/biscuit-auth.mdx
    content/docs/guide/glossary.mdx
    content/docs/tech-explanation/payment-lifecycle.mdx
    Please add frontmatter at the beginning of each file. Example:
---
title: Biscuit Authentication in Fiber
description: Overview of Biscuit authentication and how it's integrated into Fiber's RPC system
date: 2025-03-17
---
  1. Unsupported Code Block Language
    In biscuit-auth.mdx, the datalog language is not supported by Shiki (our syntax highlighter). Please change:
- datalog
+ text

How to Verify
Please run the build locally to ensure everything works:

pnpm build

Once these issues are resolved, I'll be happy to review and merge. Let me know if you have any questions!

RetricSu and others added 2 commits March 17, 2026 05:29
- 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.
- Add YAML frontmatter (title, description, date) to:
  - glossary.mdx
  - biscuit-auth.mdx
  - payment-lifecycle.mdx
- Change unsupported 'datalog' language to 'text' in biscuit-auth.mdx

Addresses review comments in nervosnetwork#38
@HappySonnyDev HappySonnyDev merged commit 7734b2a into nervosnetwork:master Mar 17, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants