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.

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

merged 1 commit into from
Nov 14, 2024

Conversation

jhaaaa
Copy link
Collaborator

@jhaaaa jhaaaa commented Nov 13, 2024

  • Changed doc-preview page to doc-status page: Preview here

    • The page provides a link to this GitHub tracking issue that people can follow to understand which docs are still to come.

    • The page also prompts people to open an issue if they need a specific doc.

  • Once this PR is approved, I'll merge it to the v3-preview branch and then merge the v3-preview branch to main, which will publish these docs to docs.xmtp.org.

  • I've created an xmtp-legacy docs branch here: https://docs-xmtp-org-git-xmtp-legacy-ephemerahq.vercel.app/ where the docs currently on docs.xmtp.org will still be referenceable.

    • The site is clearly marked as legacy with multiple pointers to the latest docs on docs.xmtp.org.
    • I'll ensure that these legacy docs are not indexed by search engines.
    • I have Plausible running on this branch just to be sure the visitor count is very low to zero.
    • Once V2 is deprecated, we can take down the doc branch. WDYT? Should we do it sooner?

JHA CREATE REDIRECTS!!!

https://docs.google.com/spreadsheets/d/1HxoN6nSpISoBiFLOg4-MF7L-UFnbDkm5JfEYZSL9NeA/edit?usp=sharing

Copy link

vercel bot commented Nov 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-xmtp-org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 13, 2024 1:59am

@@ -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. 🤷‍♀️

@@ -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

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!

@@ -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 protocolfor 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

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.

@jhaaaa jhaaaa merged commit 48c4a76 into v3-preview Nov 14, 2024
2 checks passed
@jhaaaa jhaaaa deleted the prep-main branch November 14, 2024 17:24
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