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: move getting-started/* pages to top-level #27

Merged
merged 4 commits into from
Sep 2, 2024

Conversation

ndom91
Copy link
Contributor

@ndom91 ndom91 commented Sep 2, 2024

☕️ Reasoning

🧢 Changes

  • Update getting-started sidebar structure

image

Quick notes about the sidebar:

  • It's controlled through the meta.json files
  • They always contain the file or dir name
    • If its a dir name it'll create an expandable sidebar section with all of the directories children automatically in it
    • You can then put another meta.json in the directory to customize it further
    • If its a file it'll just list that file as expected, with its frontmatter title as the title
  • You can add a few cusotm sections like the dividers we have in the root meta.json and external links
  • For more info, see: https://fumadocs.vercel.app/docs/headless/page-conventions#meta

Copy link

vercel bot commented Sep 2, 2024

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

Name Status Preview Comments Updated (UTC)
gitbutler-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 2, 2024 10:01am

Copy link

github-actions bot commented Sep 2, 2024

Broken Link Checker

1 broken links found. Links organised below by source page, or page where they were found.

1) /

Target Link Link Text Reason
/getting-started/guide "Getting Started" HTTP_404

@ndom91 ndom91 requested a review from schacon September 2, 2024 10:02
@ndom91 ndom91 changed the title fix: move getting-started/* pages to top-level fix: move getting-started/* pages to top-level Sep 2, 2024
Copy link
Member

@schacon schacon left a comment

Choose a reason for hiding this comment

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

looks 🔥

:shipit:

@schacon schacon merged commit 0aa5c3c into main Sep 2, 2024
3 checks passed
@schacon schacon deleted the ndom91/getting-started-update-sidebar-structure branch September 2, 2024 11:58
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.

2 participants