Skip to content
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

Prepare to put preview docs on main branch #75

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Prepare to put preview docs on main branch #75

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
11 changes: 11 additions & 0 deletions docs/pages/doc-status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# XMTP documentation status

We’re excited to share documentation for the latest version of XMTP.
Copy link
Member

@saulmc saulmc Nov 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

the latest version of XMTP

this is exactly the right framing for v3!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thank you for your patience and guidance around this @saulmc!


We'll be continuously releasing new and updated documentation. To follow along, see this [tracking issue](https://github.com/xmtp/docs-xmtp-org/issues/74).

Not seeing the specific documentation you need? [Open an issue](https://github.com/xmtp/docs-xmtp-org/issues/new/choose). We ❤️ doc requests.

The XMTP SDKs will continue to evolve as we add features, rename functions, and iterate based on community feedback.

Onward builders! 🫡
4 changes: 2 additions & 2 deletions docs/pages/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import "../styles.css";
<CustomHomePage.Root>
<CustomHomePage.Headline>Build with XMTP</CustomHomePage.Headline>
<CustomHomePage.Subhead>
XMTP is an open, secure, and resilient messaging protocol—for the next phase of the internet
XMTP is a secure and decentralized protocol for building communication platforms for the next phase of the internet.
Copy link
Member

Choose a reason for hiding this comment

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

Is this language we have gone over with GTM? We should have a consistent one-sentence "XMTP is..."

Copy link
Collaborator Author

@jhaaaa jhaaaa Nov 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@saulmc thank you for this callout and agreed! I will surface this topic with GTM so we can align.

</CustomHomePage.Subhead>
<CustomHomePage.TileGrid>
<CustomHomePage.Tile
Expand All @@ -16,7 +16,7 @@ import "../styles.css";
<CustomHomePage.Tile
href="/inboxes/get-started"
title="Build chat inboxes"
description="Build standalone inbox apps with DMs and group chats built with MLS"
description="Build standalone inbox apps with 1:1 and group chats built with MLS"
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice I think this is more clear than DM from what I've found recently. But we could also be more explicit and say direct message. 🤷‍♀️

icon="📥"
/>
<CustomHomePage.Tile
Expand Down
6 changes: 3 additions & 3 deletions vocs.config.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export default defineConfig({
},
title: "Build with XMTP",
description:
"XMTP is an open, secure, and resilient messaging protocol—for the next phase of the internet",
"XMTP is a secure and decentralized protocol for building communication platforms for the next phase of the internet.",
logoUrl: {
light: "/logomark-light-purple.png",
dark: "/logomark-dark-purple.png",
Expand All @@ -43,8 +43,8 @@ export default defineConfig({
],
sidebar: [
{
text: "⚡️ Documentation preview ⚡️",
link: "", // Add this line,
text: "📋 Documentation status",
link: "/doc-status",
items: [ ]
},
{
Expand Down