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

Chore: Restructure docs #2561

Merged
merged 25 commits into from
Mar 29, 2024
Merged

Conversation

Hugos68
Copy link
Contributor

@Hugos68 Hugos68 commented Mar 20, 2024

Changes:

  1. All collections are now categories under the docs collection.
  2. All categories are accompanied with a meta.mdx with metadata related to that category.
  3. Added src/content/config.ts with zod schema's to create type safe frontmatter.
  4. Added src/content/docs.ts with helpers to retrieve stuff like metadata from a category, all the categories, etc

Copy link

vercel bot commented Mar 20, 2024

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

Name Status Preview Updated (UTC)
skeleton-docs ❌ Failed (Inspect) Mar 29, 2024 10:32pm

Copy link

changeset-bot bot commented Mar 20, 2024

⚠️ No Changeset found

Latest commit: 4b1fcdf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Mar 20, 2024

@Hugos68 is attempting to deploy a commit to the Skeleton Labs Team on Vercel.

A member of the Team first needs to authorize it.

@Hugos68 Hugos68 marked this pull request as draft March 20, 2024 21:35
@endigo9740
Copy link
Contributor

endigo9740 commented Mar 20, 2024

@Hugos68 just a few odds and ends as a heads up...

I sorted an issue where the header and homepage links were linking to the inner doc sections. Be sure to pull these changes.

Noting other issues:

  • The NavGrid component is missing some data on the Installation page, its missing item.data.description data.
  • The NavGrid component is also busted on these sections: Fundamentals, Contribute, Cookbook
  • Per the sidebar, the category like "Get Started" or "Tailwind" is repeated in the list of links for all category sections
  • There's a ton of links within the content pages themselves that will need to be patched with the new URL route structure. We might need to audit this in a dedicated pass.
  • I might recommend stubbing out the root /blog pag so that's not a 404. Just put "coming soon" text.
  • The "Components" section links are not working at all (I'm sure this is expected and temporary)
  • We'll need to verify all the ChipBar component GitHub urls remain consistent with the updates. See these defined in the LayoutDoc.astro file, line 52.
  • The Contribute > Docs page will need to be updated with the new structural changes.

That aside, this seems to be moving in the right direction. Great job!

@Hugos68

This comment was marked as resolved.

@Hugos68
Copy link
Contributor Author

Hugos68 commented Mar 21, 2024

I would also like to revisit the current Layout and frontmatter structure, it seems overly complex which was neccesary at the time but I doubt this is still neccesary

@endigo9740
Copy link
Contributor

@Hugos68 sounds good, please continue as you can and keep me in the loop when this is ready for the next review.

Thanks for adding the blog page, and per the 404 page, I've noted that on the Astro Docs ticket pinned on our Issue tracker. I agree, we need that soon as well.

@endigo9740
Copy link
Contributor

endigo9740 commented Mar 26, 2024

@Hugos68 this is is fairly critical update and one we should try to wrap asap. It's likely going to start impeding the progress of other PRs soon - such as our ability to add or update new doc sections, including those needed for new components. Let me know if I can help with anything here.

@endigo9740 endigo9740 mentioned this pull request Mar 28, 2024
36 tasks
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.

None yet

2 participants