docs(cientos): align API docs with current component source - #1486
Open
TianHengZhuang wants to merge 1 commit into
Open
docs(cientos): align API docs with current component source#1486TianHengZhuang wants to merge 1 commit into
TianHengZhuang wants to merge 1 commit into
Conversation
Several cientos docs pages drifted from the implementation in `packages/cientos`. Fix the props, defaults and links that no longer match: - align: `onAlign` is not a prop (it was replaced by the `change` event), document the event instead and drop the stale row. - accumulative-shadows: `once` defaults to `true` and `blend` to `20`; the `colorBlend` row was describing `limit` and had the wrong default (`2`). - environment: drop `encoding`, it is no longer part of `EnvironmentOptions`. - image: `toneMapped` defaults to `true`, and the `transparent` row was duplicated. - use-environment: `encoding` is gone from the options and the examples, `files` is `string | string[]`, `path` is a `string` defaulting to `''`, and `syncMaterials` was missing from the table. - gltf-model / fbx-model: the relative `./use-gltf.md` and `./use-fbx.md` links pointed to files that do not exist, use the API routes instead.
✅ Deploy Preview for tresjs-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for postprocessing-tresjs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for cientos-tresjs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for tresjs-lab ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for rapier-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
While going through the cientos docs I noticed a few pages that no longer match the implementation in
packages/cientos. This PR fixes the props, defaults and links that drifted:onAlignis listed as a prop, but the component only declares/emits thechangeevent. Removed the stale row and documented the event instead.oncedefaults totrue(notfalse) andblendto20(not100). ThecolorBlendrow was describinglimitand carried its default (Infinity) instead of2.encodingis no longer part ofEnvironmentOptions, so it is removed from the props table.toneMappeddefaults totrue(the docs said0), and thetransparentrow was duplicated.encodingwas removed from the options and from both examples;filesisstring | string[],pathis astringdefaulting to''(documented asboolean/false), andsyncMaterialswas missing from the table../use-gltf.mdand./use-fbx.mdlinks point to files that do not exist; switched to the API routes used elsewhere in the docs.Evidence
Every change is backed by the component source:
align.mdpackages/cientos/src/core/abstractions/Align.vue—defineEmits+emit('change', ...)accumulative-shadows.mdpackages/cientos/src/core/light-shadow/AccumulativeShadows/component.vue—withDefaults(once: true,blend: 20,colorBlend: 2)environment.mdpackages/cientos/src/core/staging/useEnvironment/const.ts— noencodinginEnvironmentOptionsimage.mdpackages/cientos/src/core/objects/Image.vue—withDefaults(toneMapped: true)use-environment.mdpackages/cientos/src/core/staging/useEnvironment/index.ts— option destructuringgltf-model.md/fbx-model.mduse-gltf.md/use-fbx.mdfiles do not exist undercontent/2.api/3.loaders/Docs-only change, no source or runtime behaviour touched.