📝 docs: Fix invalid links in the docs #54
Conversation
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
Reviewer's GuideFixed invalid links in documentation by updating apiHeader URL templates and aligning frontmatter metadata across component and hook docs. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
👍 @iaosee |
There was a problem hiding this comment.
Hey @iaosee - I've reviewed your changes - here's some feedback:
- Consider extending your docs generator to infer
atomIdfrom the file path instead of manually adding it to each Markdown file to reduce repetition and typos. - Since you’ve changed
docUrlandsourceUrlto point at directories rather than specific index files, make sure the docs plugin can resolve directory entries and fall back toindex.md/index.tsxto prevent broken links.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider extending your docs generator to infer `atomId` from the file path instead of manually adding it to each Markdown file to reduce repetition and typos.
- Since you’ve changed `docUrl` and `sourceUrl` to point at directories rather than specific index files, make sure the docs plugin can resolve directory entries and fall back to `index.md`/`index.tsx` to prevent broken links.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
commit: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
💻 变更类型 | Change Type
🔀 变更说明 | Description of Change
All the APIHeader links are invalid above the Demo.
📝 补充信息 | Additional Information
Summary by Sourcery
Fix invalid API documentation links across the site by updating the API header configuration and correcting frontmatter in React component docs.
Documentation:
index.mdandindex.tsxsuffixes fromdocUrlandsourceUrlin the site config’s API header.atomIdfields and correct package names from@lobehub/tts/reactto@lobehub/ttsin React component markdown files.