Skip to content

Commit c22f861

Browse files
docs: add walrus-memory landing page (MystenLabs#3442)
docs: add walrus-memory landing page at /walrus-memory Add a brief landing page with cards linking to each subsection (Get Started, Concepts, Architecture, SDKs, Relayer, MCP, Contract, Indexer). The page is generated by the transform script since the walrus-memory-content directory is rebuilt from upstream on each build. Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3040200 commit c22f861

2 files changed

Lines changed: 47 additions & 8 deletions

File tree

docs/site/sidebarsWalrusMemory.js

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,9 @@
77
const sidebars = {
88
walrusMemorySidebar: [
99
{
10-
type: "html",
11-
value:
12-
'<div style="font-weight:700;font-size:1.1rem;' +
13-
"padding:0.6rem 0.75rem 0.4rem;" +
14-
"color:var(--ifm-color-primary);" +
15-
"border-bottom:1px solid var(--ifm-toc-border-color);" +
16-
'margin-bottom:0.5rem">Walrus Memory</div>',
17-
defaultStyle: true,
10+
type: "doc",
11+
id: "index",
12+
label: "Walrus Memory",
1813
},
1914
{
2015
type: "category",

docs/site/src/scripts/transform-walrus-memory-docs.js

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -779,6 +779,50 @@ function main() {
779779
count++;
780780
}
781781

782+
// Write landing page (not in upstream repo, maintained here)
783+
const landingPage = `---
784+
title: Walrus Memory
785+
description: "Portable, verifiable memory for AI agents built on Walrus and Sui."
786+
slug: /
787+
---
788+
789+
Walrus Memory gives AI agents persistent, portable memory that works across apps, sessions, and
790+
workflows. Ownership and access are enforced onchain through Sui smart contracts, and all content is
791+
encrypted through Seal before reaching Walrus.
792+
793+
<Cards>
794+
<Card title="Get Started" href="/walrus-memory/getting-started/what-is-memwal">
795+
Learn what Walrus Memory is and get up and running quickly
796+
</Card>
797+
<Card title="Concepts" href="/walrus-memory/fundamentals/concepts/memory-space">
798+
Memory spaces, ownership, delegates, and access control
799+
</Card>
800+
<Card title="Architecture" href="/walrus-memory/fundamentals/architecture/core-components">
801+
Core components, data flow, storage model, and security
802+
</Card>
803+
<Card title="TypeScript SDK" href="/walrus-memory/sdk/overview">
804+
Integrate memory into TypeScript apps with the SDK
805+
</Card>
806+
<Card title="Python SDK" href="/walrus-memory/python-sdk/quick-start">
807+
Use Walrus Memory from Python
808+
</Card>
809+
<Card title="Relayer" href="/walrus-memory/relayer/overview">
810+
Managed relayer, self-hosting, and API reference
811+
</Card>
812+
<Card title="MCP" href="/walrus-memory/mcp/overview">
813+
Model Context Protocol integration for AI tools
814+
</Card>
815+
<Card title="Smart Contract" href="/walrus-memory/contract/overview">
816+
Onchain ownership model, delegate keys, and permissions
817+
</Card>
818+
<Card title="Indexer" href="/walrus-memory/indexer/purpose">
819+
Event indexing, onchain events, and database sync
820+
</Card>
821+
</Cards>
822+
`;
823+
fs.writeFileSync(path.join(OUTPUT_DIR, "index.md"), landingPage);
824+
count++;
825+
782826
console.log(
783827
`✅ walrus-memory: transformed ${count} files → walrus-memory-content/`,
784828
);

0 commit comments

Comments
 (0)