Skip to content

docs: remove deprecated sections and migrate content for v1 release #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ihsraham wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: remove deprecated sections and migrate content for v1 release #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/learn/getting-started/_category_.json → docs/build/getting-started/_category_.json
View file
Open in desktop
File renamed without changes.
7 changes: 2 additions & 5 deletions docs/learn/getting-started/key-terms.mdx → docs/build/getting-started/key-terms.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,8 +336,5 @@ Valid combinations:

Now that you understand the vocabulary, continue to:

- **[State Channels vs L1/L2](../core-concepts/state-channels-vs-l1-l2.mdx)** — Deep comparison with other scaling solutions
- **[App Sessions](../core-concepts/app-sessions.mdx)** — Multi-party application patterns
- **[Session Keys](../core-concepts/session-keys.mdx)** — Authentication and security

For complete definitions, see the **[Glossary](/docs/protocol/glossary.mdx)**.
- **[State Channels vs L1/L2](/docs/learn/core-concepts/state-channels-vs-l1-l2)** — Deep comparison with other scaling solutions
- **[Challenge Response & Disputes](/docs/learn/core-concepts/challenge-response)** — On-chain dispute resolution
2 changes: 1 addition & 1 deletion docs/learn/getting-started/prerequisites.mdx → docs/build/getting-started/prerequisites.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ Your environment is ready! Continue to:

- **[Key Terms & Mental Models](./key-terms.mdx)** — Understand the core concepts
- **[Quickstart](./quickstart.mdx)** — Build your first Yellow App
- **[State Channels vs L1/L2](../core-concepts/state-channels-vs-l1-l2.mdx)** — Deep dive into state channels
- **[State Channels vs L1/L2](/docs/learn/core-concepts/state-channels-vs-l1-l2)** — Deep dive into state channels

---

Expand Down
0 docs/learn/getting-started/quickstart.mdx → docs/build/getting-started/quickstart.mdx
View file
Open in desktop
File renamed without changes.
0 docs/guides/migration-guide.md → docs/build/sdk/migration-guide.md
View file
Open in desktop
File renamed without changes.
6 changes: 2 additions & 4 deletions docs/guides/multi-party-app-sessions.mdx → docs/build/sdk/multi-party-app-sessions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,5 @@ console.log(`Current weight: ${signatureWeight}, Required: ${quorum}`);

## Further Reading

- [App Sessions Core Concepts](/docs/learn/core-concepts/app-sessions) — Understanding app sessions
- [App Session Methods](/docs/protocol/app-layer/off-chain/app-sessions) — Complete API reference
- [Client-Side App Session Signing Guide](/docs/guides/client-side-app-session-signing) — Signing implementation details
- [Session Keys](/docs/learn/core-concepts/session-keys) — Managing session keys
- [Protocol](/docs/protocol/introduction) — Protocol specification and architecture
- [SDK Reference](/docs/build/sdk) — Complete SDK documentation
Comment on lines +588 to +589
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Mar 30, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Consider the impact of reducing navigation specificity.

The previous "Further Reading" section provided direct links to four specific topics (App Sessions concepts, app session methods, client-side signing, and session keys). Replacing these with two general links (Protocol introduction and SDK reference) may reduce discoverability for users seeking specific information.

If the specific pages were intentionally removed, consider adding brief inline guidance about where to find topics like session key management and signing workflows within the general documentation.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/build/sdk/multi-party-app-sessions.mdx` around lines 588 - 589, The
"Further Reading" section was simplified to only include "[Protocol] — Protocol
specification and architecture" and "[SDK Reference] — Complete SDK
documentation", which reduces discoverability of session-specific topics; update
the "Further Reading" block (the section labeled "Further Reading" that
currently contains those two links) to either restore the original four specific
links (App Sessions concepts, app session methods, client-side signing, and
session keys) or, if you want to keep only the two general links, add a short
inline note under them pointing to where session key management and signing
workflows live (e.g., "For session key management and signing workflows, see:
App Sessions concepts and App session methods in the SDK Reference and
Client-side signing in Protocol docs"). Ensure the edit mentions the specific
pages by name so users can find them easily.

21 changes: 0 additions & 21 deletions docs/guides/index.md
View file
Open in desktop

This file was deleted.

9 changes: 0 additions & 9 deletions docs/guides/manuals/_category_.json
View file
Open in desktop

This file was deleted.

169 changes: 0 additions & 169 deletions docs/guides/manuals/request-asset-support.md
View file
Open in desktop

This file was deleted.

Loading
Loading