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

Fix the organization of Nextra #335

Merged
merged 28 commits into from
May 17, 2024
Merged

Fix the organization of Nextra #335

merged 28 commits into from
May 17, 2024

Conversation

jmintuitive
Copy link
Collaborator

Description

Moved the pages into the New Docs Format.

Wrote a script to automatically fix links called update-relative-links.py. Used it in conjunction with markdown-link-checker to verify that once moved all the relative links worked. (Still some external links which need to be fixed, and a couple of pages which need to be migrated - see below).

Remaining issues to be resolved in future PRs:

Checklist

Pages that still need migrating (Overall, not in this PR - but they were broken links)

Remaining TODOs on migration effort

  • Adding a reference to “Standards” to the top-level (in addition to the Smart Contracts section.

  • Write an Advanced Guides index page.

  • local-network.md in SDK section

    • TODO: As part of SDK → This is specifically referring to the one that is showing how the SDK can run a local network without the CLI.
  • Remove the "TODOs" to fix links. (Didn't see a great search to find them all before I was heading to bed - @gregnazario do you know the various formats you were using for this?)

  • Do all Lints pass?

    • [] Have you ran pnpm spellcheck?
    • Have you ran pnpm fmt?
    • Have you ran pnpm lint?

Copy link

vercel bot commented May 14, 2024

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

Name Status Preview Comments Updated (UTC)
developer-docs-nextra ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 17, 2024 0:14am

Copy link

netlify bot commented May 14, 2024

Deploy Preview for aptos-developer-docs ready!

Name Link
🔨 Latest commit 79fad7d
🔍 Latest deploy log https://app.netlify.com/sites/aptos-developer-docs/deploys/6646a0ed4d382700086988e3
😎 Deploy Preview https://deploy-preview-335--aptos-developer-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@gregnazario gregnazario left a comment

Choose a reason for hiding this comment

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

lgtm, let's fix the html files that got converted to mdx

move: "Move",
"smart-contracts": "Smart Contracts",
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we just changed this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Can you follow up with me async about this change? I think that smart-contracts is a more useful name for discovery for folks who don't know what Move is, and folks who do know what Move is will equally know this is the right section for them.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's just get this change in, and we can talk after about it.

Copy link
Collaborator

@hariria hariria left a comment

Choose a reason for hiding this comment

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

Thanks for the hard work on this. Couple things I noticed that may need some closer attention:

  1. I think the links on the landing page need to be updated as well. i.e., the links in GET STARTED WITH THESE MOVE EXAMPLES for each section (Coins, Objects, etc.) as well as the DISCOVER BLOCKCHAIN FEATURES ON APTOS section
  2. We need to find another place to put the Wallet markdown doc in Standards

@jmintuitive
Copy link
Collaborator Author

2. We need to find another place to put the Wallet markdown doc in Standards

Why do we need to find another place to put the Wallet markdown doc?

@hariria
Copy link
Collaborator

hariria commented May 16, 2024

2. We need to find another place to put the Wallet markdown doc in Standards

Why do we need to find another place to put the Wallet markdown doc?

The Wallet standards are unrelated to Smart Contracts

@jmintuitive
Copy link
Collaborator Author

nit: I noticed when merging that we're adding → to every Card.Title. That seems really easy to forget over time, plus a bit annoying to find that character to copy + paste when adding new cards - @hariria would it make sense to add that to the Card.Title component instead? (With an optional flag to turn off potentially).

Copy link
Collaborator

@hariria hariria left a comment

Choose a reason for hiding this comment

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

Yep I can modify Card.Title in a future PR to take in a -> arrow prop.

Comment on lines -1 to -4
---
title: "SDKs"
---

Copy link
Collaborator

Choose a reason for hiding this comment

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

Could we leave this here?

@hariria hariria merged commit 8c1a841 into aptos-labs:main May 17, 2024
8 checks passed
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