search

dahlia / hollo

Federated single-user microblogging software
https://docs.hollo.social/
GNU Affero General Public License v3.0
236 stars 16 forks source link

docs: use absolute paths #32

Closed honnip closed 1 month ago

honnip commented 1 month ago

https://docs.hollo.social has a trailing slash as opposed to local preview.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve updates to the documentation for deploying Hollo using Docker and manual installation across multiple language versions. The primary modification is the alteration of links from relative paths to absolute paths for sections related to "Environment variables" and "Railway" deployment. This change aims to improve navigability and ensure users can access the correct documentation sections regardless of their current location within the site structure.

Changes

File Path Change Summary
docs/src/content/docs/install/docker.mdx Updated link to "Environment variables" from ./env to /install/env.
docs/src/content/docs/install/manual.mdx Updated links for "Railway" and "Environment variables" from relative to absolute paths.
docs/src/content/docs/install/railway.mdx Updated link for "Environment variables" from ./env to /install/env; minor formatting changes.
docs/src/content/docs/ja/install/docker.mdx Updated link for "環境変数" from ./env to /ja/install/env.
docs/src/content/docs/ja/install/manual.mdx Updated links for "Railway" and "環境変数" from relative to absolute paths.
docs/src/content/docs/ja/install/railway.mdx Updated link for "環境变量" from ./env to /ja/install/env; corrected description typo.
docs/src/content/docs/ko/install/docker.mdx Updated link for "환경 변수" from ./env to /ko/install/env.
docs/src/content/docs/ko/install/manual.mdx Updated links for "Railway" and "환경 변수" from relative to localized paths.
docs/src/content/docs/ko/install/railway.mdx Updated link for "환경 변수" from ./env to /ko/install/env; corrected description typo.
docs/src/content/docs/zh-cn/install/docker.mdx Updated link for "环境变量" from ./env to /zh-cn/install/env.
docs/src/content/docs/zh-cn/install/manual.mdx Updated links for "Railway" and "环境变量" from relative to absolute paths.
docs/src/content/docs/zh-cn/install/railway.mdx Updated link for "环境变量" from ./env to /zh-cn/install/env.

Poem

🐇 In the garden where links grow bright,
Paths now lead with clearer light.
From ./env to roads so wide,
Documentation's a joyful ride!
Hop along, dear friends, with glee,
Navigate with ease, as it should be! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `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 generate unit testing code for this file.` - `@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 generate unit testing code.` - `@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.` 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.