Skip to content

Docs Updates #4 - Move Framework Content#669

Open
bryantgillespie wants to merge 12 commits into
bry/dockem-3-language-cleanupfrom
bry/dockem-4-tutorial-to-framework
Open

Docs Updates #4 - Move Framework Content#669
bryantgillespie wants to merge 12 commits into
bry/dockem-3-language-cleanupfrom
bry/dockem-4-tutorial-to-framework

Conversation

@bryantgillespie
Copy link
Copy Markdown
Member

@bryantgillespie bryantgillespie commented Apr 30, 2026

Instead of having a messy tutorial section, this PR creates a new framework section and moves those tutorials into their proper locations. It also adds nice labels for the navigation, making it easy to navigate between them. It adds framework overview pages, which are good for SEO purposes and also nice for users / developers to easily find framework content.

Framework Index Page

CleanShot 2026-04-30 at 14 11 23@2x

Individual Framework Page

CleanShot 2026-04-30 at 14 10 00@2x

This pull request introduces a comprehensive "Frameworks" section to the documentation site, enhancing navigation, discoverability, and contextual presentation of framework-specific guides and tutorials. It implements new components for listing frameworks and their guides, updates the navigation structure, and improves the user experience for both framework and tutorial pages.

Frameworks Section & Navigation Improvements:

  • Added a new /frameworks hub page that lists all supported frameworks, each with a guide count and icon, using the new FrameworkLinks and FrameworkLinkList components. (app/pages/frameworks/index.vue, app/components/content/FrameworkLinks.vue, app/components/FrameworkLinkList.vue, README.md) [1] [2] [3] [4]
  • Implemented per-framework guide listings, grouping guides into "Start Here" and "Guides" sections, and displaying related tutorials for each framework. (app/components/content/FrameworkGuideList.vue)
  • Enhanced the docs layout to support framework-aware navigation, including a dropdown for framework selection, dynamic sidebar navigation, and contextual section headers. (app/layouts/docs.vue) [1] [2] [3] [4]

Page Presentation & UX Enhancements:

Navigation Structure Updates:

  • Updated the main navigation to add "Frameworks" and move "Tutorials" under "Resources" for better organization. (app/app.config.ts) [1] [2] [3]

Other Improvements:

  • Improved cache key naming for tutorial article previews to include the limit parameter, preventing cache collisions. (app/components/TutorialsArticles.vue)

These changes collectively provide a more intuitive and powerful framework-centric experience for users browsing documentation and tutorials.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 30, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 14, 2026 9:35pm

Request Review

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Reorganizes framework-specific tutorials into a dedicated /frameworks/<framework>/ content hierarchy with per-framework hub pages, adds a /frameworks index, framework-aware navigation (dropdown + section header) in the docs layout, and a comprehensive set of 301 redirects from the old tutorial URLs. Also adds a section frontmatter field for grouping ("Start Here" vs "Guides") and small fixes to slugs, technologies, and the redirect rule key construction.

Changes:

  • New /frameworks hub + per-framework overview pages, plus FrameworkLinks, FrameworkLinkList, and FrameworkGuideList components and a framework-aware sidebar with a framework dropdown.
  • Moves the old tutorials/getting-started/* framework guides to content/frameworks/<slug>/<topic>.md with new slugs, section grouping, and per-framework .navigation.yml; updates internal links and adds a 50+ entry redirects.json.
  • Tutorial page now shows framework chips derived from technologies; layout/nav adjustments and a findNavNode helper; redirects.json keys no longer include BASE_URL (the rule keys are now relative paths).

Reviewed changes

Copilot reviewed 114 out of 117 changed files in this pull request and generated no comments.

Show a summary per file
File Description
redirects.json Adds 301 redirects from old tutorial paths to new framework paths.
nuxt.config.ts Drops BASE_URL prefix from redirect rule keys.
content.config.ts Adds section enum to content schema.
content/frameworks/**/* Moves tutorials into framework folders, adds section/navigation frontmatter, new index pages, and .navigation.yml icons/titles.
content/tutorials/**/* Slug/technology fixes; new create-reusable-blocks-... page; removes tutorials/getting-started/index.md.
content/guides/**/* Updates cross-links to new framework paths.
content/index.md Adds :framework-links and points CTA to /frameworks.
app/pages/frameworks/index.vue New frameworks hub page.
app/pages/[...slug].vue Adds 404 for .navigation paths and framework breadcrumb/icon header.
app/pages/tutorials/[category]/[...slug].vue Replaces generated header image with framework chips.
app/layouts/docs.vue Adds framework dropdown and dedicated framework sidebar nav.
app/components/content/FrameworkLinks.vue, FrameworkGuideList.vue, app/components/FrameworkLinkList.vue New content components for listing frameworks/guides/tutorials.
app/components/TutorialsArticles.vue Cache key now includes limit to avoid collisions.
app/utils/findNavNode.ts, app/types/content.d.ts Helper for nav lookups and content type augmentation.
app/app.config.ts Adds "Frameworks" nav entry; relabels "Deploy" → "Hosting"; moves Tutorials under Resources.
README.md Documents framework authoring conventions.
.gitignore Ignores .claude/scheduled_tasks.lock.
Comments suppressed due to low confidence (1)

content/frameworks/01.nextjs/10.multilingual-content.md:7

  • Removing the only - nextjs list item leaves technologies: as an empty (null) key in the frontmatter. Per content.config.ts, technologies is z.array(z.string()).optional(), which accepts undefined but not null — this will likely fail content schema validation. Either remove the technologies: key entirely, or keep a properly indented entry. The same problem exists in content/frameworks/12.swift/02.authentication.md and content/frameworks/07.laravel/01.data-fetching.md, where the only list item was similarly removed.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bryantgillespie bryantgillespie marked this pull request as ready for review May 14, 2026 16:00
@bryantgillespie bryantgillespie requested a review from a team as a code owner May 14, 2026 16:00
@bryantgillespie bryantgillespie requested a review from JamesW1 May 14, 2026 16:00
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