fix dead links in repo #1626
Open
fix dead links in repo #1626
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
✅ Deploy Preview for docs-optimism ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 Walkthrough## Walkthrough
This set of changes updates several documentation URLs across YAML issue templates and markdown documentation pages. The modifications involve replacing outdated or reorganized links with new URLs that point to revised sections of the Optimism documentation, such as style guides for FAQs, troubleshooting, content types, and interface references in tutorials. No structural, logical, or functional changes are introduced; the updates are limited to correcting or clarifying documentation links to ensure they direct users to the intended and current resources.
## Possibly related PRs
- ethereum-optimism/docs#814: Fixes broken links by updating file references and URLs in documentation files, similar to the main PR's focus on updating documentation links.
- ethereum-optimism/docs#1023: Updates links to the `OptimismMintableERC20Factory` and interface in a tutorial, which aligns with the main PR's corrections to interface references in documentation.
- ethereum-optimism/docs#1553: Updates the link in "upgrade-14.mdx" to a different upgrade proposal URL, directly modifying the same file as the main PR.
## Suggested reviewers
- krofax
- sbvegan📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
.github/ISSUE_TEMPLATE/suggest_faq_item.yaml(1 hunks).github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml(1 hunks).github/ISSUE_TEMPLATE/suggest_tutorial.yaml(1 hunks)pages/app-developers/tutorials/bridging/standard-bridge-custom-token.mdx(2 hunks)pages/notices/upgrade-14.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/notices/upgrade-14.mdxpages/app-developers/tutorials/bridging/standard-bridge-custom-token.mdx
🔇 Additional comments (5)
.github/ISSUE_TEMPLATE/suggest_troubleshooting_item.yaml (1)
9-9: Updated troubleshooting link is correct and consistent.The URL now points to
docs.optimism.io/connect/contribute/style-guide#troubleshooting-guides, aligning with the reorganized style guide structure..github/ISSUE_TEMPLATE/suggest_tutorial.yaml (1)
9-9: Tutorial style guide link updated correctly.The anchor
style-guide#content-typeson theconnectsubdomain accurately reflects the updated documentation path.pages/app-developers/tutorials/bridging/standard-bridge-custom-token.mdx (2)
26-26: Interface import path updated correctly.The link to
interfaces/universal/IOptimismMintableERC20.solon versionv1.12.2matches the new directory structure.
36-36: Consistent interface reference ensured.This reference now consistently points to the updated
IOptimismMintableERC20.solinterface location..github/ISSUE_TEMPLATE/suggest_faq_item.yaml (1)
9-9: FAQ content link updated accurately.The link to
connect/contribute/style-guide#faqsand the example tostack/security/faq#faqcorrectly reflect the reorganized documentation.
|
@zeroprooff Can you fix the lint issues in this PR |
|
ready, thanks! |
This is why the build fails, once you get it corrected, please ping me so i can merge. |
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.
hey! fixed dead links