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

Update the structure of props and options reference #1136

Closed

Conversation

amirhhashemi
Copy link
Collaborator

@amirhhashemi amirhhashemi commented Mar 21, 2025

  • I have read the Contribution guide
  • This PR references an issue (except for typos, broken links, or other minor problems)

Description(required)

This PR changes the structure of how we document props, parameters, and options. Instead of using a table format, we will now present the documentation as follows:

## Options

### `deferStream`

**Type:** `boolean`

**Default:** `false`

Description...

This new format allows for several benefits:

  1. Improved indexing of content by search engines and Orama.
  2. The ability to add additional information about a prop or option, such as examples that could not be accommodated in a table format.
  3. The ability to link directly to the documentation of a specific prop, as links are automatically generated for headings.

Related issues & labels

Sorry, something went wrong.

Copy link

stackblitz bot commented Mar 21, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Copy link

netlify bot commented Mar 21, 2025

Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit 4461182
🔍 Latest deploy log https://app.netlify.com/sites/solid-docs/deploys/67dd262da731f300089bb7d4
😎 Deploy Preview https://deploy-preview-1136--solid-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

netlify bot commented Mar 21, 2025

Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit 54bf11c
🔍 Latest deploy log https://app.netlify.com/sites/solid-docs/deploys/67dd7df6e5d985000902ef8e
😎 Deploy Preview https://deploy-preview-1136--solid-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.

@amirhhashemi amirhhashemi marked this pull request as draft March 21, 2025 09:00
@amirhhashemi amirhhashemi marked this pull request as ready for review March 21, 2025 14:56
@LadyBluenotes
Copy link
Member

I'm not a fan of this change. I can understand why you may want to make it, but this was made without any prior conversation and it's structurally too large of a change to make without input.

I'm going to close this while we talk about how we can approach this, but I'll reach out so we can have that discussion.

Do you mind, for the time being, just putting the deferStream stuff in it's own PR? This also shouldn't have been lumped in all together.

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.

[content] Improve documentation on deferStream
2 participants