-
Notifications
You must be signed in to change notification settings - Fork 48
feat: Community App Guides section and Paperless NGX placeholder #407
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
grizzlechips
wants to merge
36
commits into
unraid:main
Choose a base branch
from
grizzlechips:community-app-guides
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
45ee720
docs: enhance documentation with comprehensive content expansions and…
4bb42ed
Merge branch 'main' of https://github.com/unraid/docs
ba26e71
Merge branch 'main' of https://github.com/unraid/docs
55a491e
docs: apply CodeRabbit formatting and clarity improvements
f09af34
docs: fix VM snapshot memory dump guidance (CodeRabbit)
8c00d78
Merge remote-tracking branch 'upstream/main'
c5d59fe
docs: Fix VM paths, icon organization, and rebuild instructions
d8ce64c
docs: Organize notification agent icons in dedicated static directory
b35b7ac
Merge remote-tracking branch 'upstream/main'
41581ba
docs: Flatten tabbed content and improve documentation accessibility
9c55e3f
refactor: update sidebar sorting and improve documentation clarity
393e605
fix: update iframe attributes to JSX camelCase format
52f84c7
Merge upstream/main: resolve conflicts in release notes and documenta…
914b829
Merge upstream/main: sync with 7.2.0 release notes update
28bf859
docs: Update FAQ structure and table of contents settings
122f77d
docs: Update FAQ and Licensing FAQ for improved structure and accessi…
3a63f3a
Merge branch 'main' of https://github.com/grizzlechips/docs
ccb57e8
Merge upstream/main: Bring in Unraid Account section and latest changes
d582a4b
chore: update documentation for API and configuration improvements
5e539e5
fix: update documentation and image paths for ZFS storage
47b247f
fix: update image paths in ZFS storage documentation
9f89784
fix: update release notes for Unraid OS 7.2.0
3f0fc6b
fix: update Docusaurus configuration and release notes formatting
62f14f5
Merge branch 'main' into main
ljm42 fd459fa
Update documentation for Unraid OS settings and features
a72fcac
Update ZFS storage documentation image reference
0a56ce3
Update documentation and configuration files
c74cfe8
Merge branch 'main' of https://github.com/grizzlechips/docs
fb1bd15
Refactor docusaurus.config.ts structure and update licensing FAQ docu…
3e7f0ea
Refactor markdown configuration in docusaurus.config.ts
fd3db67
Refactor markdown configuration in docusaurus.config.ts
162251a
feat: add initial guides page
elibosley e70e5e3
Merge PR 405: add initial guides section
43033cf
feat: Community App Guides section with Paperless NGX dummy page
5a9e196
Merge branch 'main' into community-app-guides
grizzlechips 227f856
Merge branch 'main' into community-app-guides
elibosley File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| sidebar_position: 1 | ||
| title: About these guides | ||
| slug: / | ||
| --- | ||
|
|
||
| This section contains step-by-step tutorials and how-to guides for third-party and community applications that run on Unraid. It is maintained separately from the main Unraid documentation. | ||
|
|
||
| These guides provide general setup steps for common self-hosted applications; however, we strongly recommend reviewing each application's official documentation for detailed support and troubleshooting. | ||
|
|
||
| There is no guarantee that every guide will remain current. However, for popular guides, we may dedicate resources to update them to the best of our ability. | ||
|
|
||
| ## Contributing to or using a guide | ||
|
|
||
| - Each guide **must** include a "Last validated [date]" note indicating when the steps were last reviewed. | ||
| - If you notice that a guide is out of date, you can suggest changes via pull requests or report issues in the repository so the community can help keep useful guides current. | ||
|
|
||
| More guides will be added over time. If you have a guide you'd like to submit, see the [main documentation repository](https://github.com/unraid/docs) for contribution guidelines. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| sidebar_position: 2 | ||
| title: Paperless NGX | ||
| description: Paperless NGX on Unraid | ||
| --- | ||
|
|
||
| :::info[Last validated] | ||
|
|
||
| *[Date to be filled when real content is added]* | ||
|
|
||
| ::: | ||
|
|
||
| ## Paperless NGX on Unraid | ||
|
|
||
| This is a placeholder page for the Paperless NGX guide. It demonstrates how a guide appears in the Community App Guides section alongside the rest of the site. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ | ||
| const sidebars = { | ||
| guidesSidebar: [{ type: 'autogenerated', dirName: '.' }], | ||
| }; | ||
|
|
||
| module.exports = sidebars; |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: unraid/docs
Length of output: 10987
🏁 Script executed:
Repository: unraid/docs
Length of output: 720
🏁 Script executed:
Repository: unraid/docs
Length of output: 1107
🏁 Script executed:
Repository: unraid/docs
Length of output: 155
🌐 Web query:
Docusaurus v3.9.2 EditUrlFunction type signature return value💡 Result:
In Docusaurus v3.9.2,
EditUrlFunctionis typed to return either a string edit URL or undefined (to disable the edit link for that specific doc):[1]
createEditUrlreturn type prevents suppressing edit links for guides in non-default localesDocusaurus v3.9.2's
EditUrlFunctionsignature returnsstring | undefined— returningundefinedsuppresses the "Edit this page" button entirely. The current return typestringprevents this.Since
createEditUrlis shared by both the main docs preset and the guides plugin, every non-default-locale page in/guides/will show an edit link pointing tohttps://translate.unraid.net/unraid-docs/${locale}— a page unrelated to community guides if they aren't on the translation platform.Change the return type to
string | undefinedand returnundefinedfor the guides plugin in non-default locales (or conditionally based onversionDocsDirPath === "guides").🤖 Prompt for AI Agents