Skip to content

Conversation

@ihsraham
Copy link
Collaborator

@ihsraham ihsraham commented Nov 27, 2025

  • Added Introduction and Getting started sections with relevant pages under it
  • Added Core concepts section with relevant pages
  • Divided session keys doc to two parts: one is concepts and other is the one with code snippets, so placed them accordingly

@ihsraham ihsraham requested a review from dpatsora as a code owner November 27, 2025 08:29
@ihsraham ihsraham changed the title Learn restructuring: added intro and core concepts YNU-508 & YNU-508: Adding, Intro, getting started and core concepts section to Learn Nov 28, 2025
@ihsraham ihsraham changed the title YNU-508 & YNU-508: Adding, Intro, getting started and core concepts section to Learn YNU-508 & YNU-509: Adding, Intro, getting started and core concepts section to Learn Nov 28, 2025

- **[Build](/docs/build/quick-start)** — Implement complete Yellow Applications
- **[Protocol Reference](/docs/protocol/introduction)** — Authoritative protocol specification
- **[API Reference](/docs/api-reference)** — SDK and RPC method documentation
Copy link
Collaborator

Choose a reason for hiding this comment

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

Don't mention it, as it's outdated

@@ -0,0 +1,9 @@
{
Copy link
Collaborator

Choose a reason for hiding this comment

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

@philanton @nksazonov I think we can remove deprecated docs completely from here

Copy link
Collaborator

Choose a reason for hiding this comment

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

I wouldn't hesitate

BASE_RPC_URL=https://base-sepolia.g.alchemy.com/v2/YOUR_KEY

# Clearnode WebSocket endpoint
CLEARNODE_WS_URL=wss://clearnode.yellow.com/ws
Copy link
Collaborator

Choose a reason for hiding this comment

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

It should be either prod (wss://clearnet.yellow.com/ws) or sandbox (wss://clearnet-sandbox.yellow.com/ws)

npx tsx scripts/create-wallet.ts
```

### Get Test Tokens
Copy link
Collaborator

Choose a reason for hiding this comment

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

Test tokens are available only on Sandbox deployment. The following command can be used to request ytest.USD on user's unified balance:

curl -XPOST https://clearnet-sandbox.yellow.com/faucet/requestTokens -d '{"userAddress":"<user_address>"}'

Once requested, you won't need to perform any off-chain operation as tokens are already on unified balance.

# Clearnode WebSocket endpoint
CLEARNODE_WS_URL=wss://clearnode.yellow.com/ws

# Contract addresses (get from Yellow Network docs)
Copy link
Collaborator

Choose a reason for hiding this comment

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

They are not necessary to be specified here, as once connected to clearnode get_config endpoint can be used to find all supported chains and addresses of the contracts deployed there


---

## Supported Networks
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do not mention them here, they should be either on the separate page or you can just say that they can find all supported chains by calling get_config endpoint on Clearnode

Comment on lines +143 to +145
weights: [40, 40, 50], // Voting power
quorum: 80, // Required weight for state updates
challenge: 3600, // Dispute window
Copy link
Collaborator

Choose a reason for hiding this comment

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

Comments are not aligned

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.

4 participants