Skip to content

Remove details on submitting PRs#282

Merged
ljm42 merged 1 commit intomainfrom
fix-disable-contributions
May 23, 2025
Merged

Remove details on submitting PRs#282
ljm42 merged 1 commit intomainfrom
fix-disable-contributions

Conversation

@ljm42
Copy link
Member

@ljm42 ljm42 commented May 23, 2025

We are in the process of reorganizing / rewriting the docs, disable contributions for now

Before Submitting This PR, Please Ensure You Have Completed The Following:

  1. Are internal links to wiki documents using relative file links?
  2. Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
  3. Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
  4. Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  5. Is the build succeeding?

Summary by CodeRabbit

  • Documentation
    • Removed multiple contributor guides, tutorials, and style guide documents from the documentation site.
    • Deleted category metadata and navigation structure related to contribution and style guide sections.
  • Chores
    • Disabled "edit this page" links and editing of localized files in the documentation interface.

We are in the process of reorganizing / rewriting the docs, disable contributions for now
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 23, 2025

📝 Walkthrough

Walkthrough

This change removes a large set of documentation files and category metadata related to contributing to the documentation, including style guides, contribution instructions, and Docusaurus tutorials. Additionally, the Docusaurus configuration is updated by commenting out the properties that enabled "edit this page" links and localized file editing.

Changes

File(s) Change Summary
docs/contribute-to-docs/category.json, docs/contribute-to-docs/docusaurus/category.json, docs/contribute-to-docs/docusaurus/tutorial-basics/category.json, docs/contribute-to-docs/docusaurus/tutorial-extras/category.json, docs/contribute-to-docs/unraid-styleguide/category.json Deleted category JSON files that defined documentation structure and navigation metadata.
docs/contribute-to-docs/docusaurus/docusaurus.md, docs/contribute-to-docs/docusaurus/tutorial-basics/congratulations.md, docs/contribute-to-docs/docusaurus/tutorial-basics/create-a-document.md, docs/contribute-to-docs/docusaurus/tutorial-basics/create-a-page.md, docs/contribute-to-docs/docusaurus/tutorial-basics/markdown-features.mdx, docs/contribute-to-docs/docusaurus/tutorial-extras/manage-docs-versions.md, docs/contribute-to-docs/docusaurus/tutorial-extras/translate-your-site.md Deleted Docusaurus-related tutorial and guidance markdown/MDX files.
docs/contribute-to-docs/how-to-contribute.md, docs/contribute-to-docs/intro.md, docs/contribute-to-docs/redirect_list.mdx Deleted general contribution guides and redirect list documentation.
docs/contribute-to-docs/unraid-styleguide/conventions.md, docs/contribute-to-docs/unraid-styleguide/golden-rules.md, docs/contribute-to-docs/unraid-styleguide/introduction.md Deleted style guide documentation files for writing and contribution standards.
docusaurus.config.js Commented out editUrl and editLocalizedFiles in the docs preset, disabling edit links.

Poem

The docs have hopped away today,
Style guides and guides all swept astray.
No more "edit this page" to click,
The bunny’s broom was fast and quick.
With empty burrows left behind,
New paths for docs we’ll surely find!
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b11a7eb and b7605e0.

⛔ Files ignored due to path filters (2)
  • docs/contribute-to-docs/docusaurus/tutorial-extras/img/docsVersionDropdown.png is excluded by !**/*.png
  • docs/contribute-to-docs/docusaurus/tutorial-extras/img/localeDropdown.png is excluded by !**/*.png
📒 Files selected for processing (19)
  • docs/contribute-to-docs/_category_.json (0 hunks)
  • docs/contribute-to-docs/docusaurus/_category_.json (0 hunks)
  • docs/contribute-to-docs/docusaurus/docusaurus.md (0 hunks)
  • docs/contribute-to-docs/docusaurus/tutorial-basics/_category_.json (0 hunks)
  • docs/contribute-to-docs/docusaurus/tutorial-basics/congratulations.md (0 hunks)
  • docs/contribute-to-docs/docusaurus/tutorial-basics/create-a-document.md (0 hunks)
  • docs/contribute-to-docs/docusaurus/tutorial-basics/create-a-page.md (0 hunks)
  • docs/contribute-to-docs/docusaurus/tutorial-basics/markdown-features.mdx (0 hunks)
  • docs/contribute-to-docs/docusaurus/tutorial-extras/_category_.json (0 hunks)
  • docs/contribute-to-docs/docusaurus/tutorial-extras/manage-docs-versions.md (0 hunks)
  • docs/contribute-to-docs/docusaurus/tutorial-extras/translate-your-site.md (0 hunks)
  • docs/contribute-to-docs/how-to-contribute.md (0 hunks)
  • docs/contribute-to-docs/intro.md (0 hunks)
  • docs/contribute-to-docs/redirect_list.mdx (0 hunks)
  • docs/contribute-to-docs/unraid-styleguide/_category_.json (0 hunks)
  • docs/contribute-to-docs/unraid-styleguide/conventions.md (0 hunks)
  • docs/contribute-to-docs/unraid-styleguide/golden-rules.md (0 hunks)
  • docs/contribute-to-docs/unraid-styleguide/introduction.md (0 hunks)
  • docusaurus.config.js (1 hunks)
💤 Files with no reviewable changes (18)
  • docs/contribute-to-docs/category.json
  • docs/contribute-to-docs/docusaurus/tutorial-basics/category.json
  • docs/contribute-to-docs/unraid-styleguide/category.json
  • docs/contribute-to-docs/docusaurus/tutorial-basics/create-a-page.md
  • docs/contribute-to-docs/docusaurus/category.json
  • docs/contribute-to-docs/docusaurus/tutorial-extras/category.json
  • docs/contribute-to-docs/redirect_list.mdx
  • docs/contribute-to-docs/unraid-styleguide/introduction.md
  • docs/contribute-to-docs/docusaurus/tutorial-basics/create-a-document.md
  • docs/contribute-to-docs/docusaurus/tutorial-basics/markdown-features.mdx
  • docs/contribute-to-docs/docusaurus/tutorial-extras/translate-your-site.md
  • docs/contribute-to-docs/how-to-contribute.md
  • docs/contribute-to-docs/docusaurus/docusaurus.md
  • docs/contribute-to-docs/docusaurus/tutorial-extras/manage-docs-versions.md
  • docs/contribute-to-docs/unraid-styleguide/golden-rules.md
  • docs/contribute-to-docs/docusaurus/tutorial-basics/congratulations.md
  • docs/contribute-to-docs/unraid-styleguide/conventions.md
  • docs/contribute-to-docs/intro.md
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: AWS Amplify Console Web Preview
🔇 Additional comments (1)
docusaurus.config.js (1)

53-54: Confirmed disabling of edit links
Commenting out editUrl and editLocalizedFiles correctly disables the "Edit this page" links and localized file editing, aligning with the temporary pause on contributions.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@aws-amplify-us-west-2
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-282.d1o5s833kbd339.amplifyapp.com

@ljm42 ljm42 merged commit 6d1cb53 into main May 23, 2025
3 checks passed
@ljm42 ljm42 deleted the fix-disable-contributions branch May 23, 2025 23:28
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.

1 participant