Skip to content

Conversation

@iitzIrFan
Copy link
Contributor

What is it?

Solves: #6678

  • Feature / enhancement
  • Docs / tests / types / typos

Description

  1. API Reference Update:
    A new section was added to the API reference file (index.mdx) to explain how useContent can retrieve headings from .mdx files. This included an example and practical use cases.

  2. New Practical Guide:
    A new file, use-content-headings.mdx, was created in the main documentation section. This file provides a user-friendly guide on using useContent to retrieve page headings, complete with an example, notes, and use cases.

Checklist

  • My code follows the developer guidelines of this project
  • I performed a self-review of my own code
  • I added a changeset with pnpm change
  • I made corresponding changes to the Qwik docs
  • I added new tests to cover the fix / functionality

@iitzIrFan iitzIrFan requested a review from a team as a code owner October 19, 2025 10:37
@changeset-bot
Copy link

changeset-bot bot commented Oct 19, 2025

⚠️ No Changeset found

Latest commit: ac90eb9

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

@github-actions
Copy link
Contributor

github-actions bot commented Oct 19, 2025

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
qwik-docs ✅ Ready (View Log) Visit Preview e5e3fc2

@AdrianRomanski
Copy link
Contributor

Looks like duplicate #7303

Copy link
Member

@gioboa gioboa left a comment

Choose a reason for hiding this comment

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

I think we need to change the position of this file.
.../docs/use-content-headings.mdx
all the other pages are inside a specific folder.

@gioboa gioboa requested a review from maiieul October 20, 2025 08:10
@gioboa gioboa added the COMP: docs Improvements or additions to documentation label Oct 20, 2025
@gioboa gioboa changed the title Docs/usecontent headings guide docs: add useContent headings guide Oct 20, 2025
@iitzIrFan
Copy link
Contributor Author

@gioboa Thanks for your review and yes had updates the position of the file.

@iitzIrFan iitzIrFan requested a review from gioboa October 20, 2025 11:51
@maiieul
Copy link
Member

maiieul commented Oct 23, 2025

Hey @iitzIrFan thanks for the PR. Giorgio and I think it would make more sense to have it in /docs/guides/mdx/. Can you do that change please?

@iitzIrFan
Copy link
Contributor Author

iitzIrFan commented Oct 23, 2025

Sure @maiieul, updated the pr!

@maiieul
Copy link
Member

maiieul commented Oct 24, 2025

Thanks @irfanullahjan but I meant we already have a route https://qwik.dev/docs/guides/mdx/. Please move your changes here and remove the changes from /api.

@maiieul
Copy link
Member

maiieul commented Oct 24, 2025

The changes should be in the index.mdx

@iitzIrFan
Copy link
Contributor Author

@maiieul PR updated! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

COMP: docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants