mirror of
https://github.com/sct/overseerr.git
synced 2025-09-27 12:39:46 +02:00
feat(frontend): add documentation link to about page
Also updates the README with new documentation links
This commit is contained in:
11
README.md
11
README.md
@@ -36,16 +36,21 @@
|
|||||||
|
|
||||||
- User profiles.
|
- User profiles.
|
||||||
- User settings page (to give users the ability to modify their Overseerr experience to their liking).
|
- User settings page (to give users the ability to modify their Overseerr experience to their liking).
|
||||||
- Version update notifications in-app.
|
|
||||||
- 4K requests (Includes multi-radarr/sonarr management for media)
|
- 4K requests (Includes multi-radarr/sonarr management for media)
|
||||||
|
|
||||||
## Planned Features
|
## Planned Features
|
||||||
|
|
||||||
- More notification types (Slack/Telegram/etc.).
|
- More notification types.
|
||||||
- Issues system. This will allow users to report issues with content on your media server.
|
- Issues system. This will allow users to report issues with content on your media server.
|
||||||
- Local user system (for those who don't use Plex).
|
- Local user system (for those who don't use Plex).
|
||||||
- Compatibility APIs (to work with existing tools in your system).
|
- Compatibility APIs (to work with existing tools in your system).
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Check out our documenation for steps on how to install and run Overseerr:
|
||||||
|
|
||||||
|
https://docs.overseerr.dev/getting-started/installation
|
||||||
|
|
||||||
## Running Overseerr
|
## Running Overseerr
|
||||||
|
|
||||||
Currently, Overseerr is only distributed through Docker images. If you have Docker, you can run Overseerr as per:
|
Currently, Overseerr is only distributed through Docker images. If you have Docker, you can run Overseerr as per:
|
||||||
@@ -70,6 +75,7 @@ After running Overseerr for the first time, configure it by visiting the web UI
|
|||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
|
- Check out the [Overseerr Documentation](https://docs.overseerr.dev/) before asking for help. Your question might already be in the [FAQ](https://docs.overseerr.dev/support/faq).
|
||||||
- You can get support on [Discord](https://discord.gg/PkCWJSeCk7).
|
- You can get support on [Discord](https://discord.gg/PkCWJSeCk7).
|
||||||
- You can ask questions in the Help category of our [GitHub Discussions](https://github.com/sct/overseerr/discussions).
|
- You can ask questions in the Help category of our [GitHub Discussions](https://github.com/sct/overseerr/discussions).
|
||||||
- Bugs/Feature Requests can be opened via a [GitHub issue](https://github.com/sct/overseerr/issues).
|
- Bugs/Feature Requests can be opened via a [GitHub issue](https://github.com/sct/overseerr/issues).
|
||||||
@@ -135,4 +141,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||||||
|
|
||||||
<!-- markdownlint-enable -->
|
<!-- markdownlint-enable -->
|
||||||
<!-- prettier-ignore-end -->
|
<!-- prettier-ignore-end -->
|
||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||||
|
@@ -18,6 +18,7 @@ const messages = defineMessages({
|
|||||||
timezone: 'Timezone',
|
timezone: 'Timezone',
|
||||||
supportoverseerr: 'Support Overseerr',
|
supportoverseerr: 'Support Overseerr',
|
||||||
helppaycoffee: 'Help pay for coffee',
|
helppaycoffee: 'Help pay for coffee',
|
||||||
|
documentation: 'Documentation',
|
||||||
});
|
});
|
||||||
|
|
||||||
const SettingsAbout: React.FC = () => {
|
const SettingsAbout: React.FC = () => {
|
||||||
@@ -56,6 +57,16 @@ const SettingsAbout: React.FC = () => {
|
|||||||
</div>
|
</div>
|
||||||
<div className="mb-8">
|
<div className="mb-8">
|
||||||
<List title={intl.formatMessage(messages.gettingsupport)}>
|
<List title={intl.formatMessage(messages.gettingsupport)}>
|
||||||
|
<List.Item title={intl.formatMessage(messages.documentation)}>
|
||||||
|
<a
|
||||||
|
href="https://docs.overseerr.dev"
|
||||||
|
target="_blank"
|
||||||
|
rel="noreferrer"
|
||||||
|
className="text-indigo-500 hover:underline"
|
||||||
|
>
|
||||||
|
https://docs.overseerr.dev
|
||||||
|
</a>
|
||||||
|
</List.Item>
|
||||||
<List.Item title={intl.formatMessage(messages.githubdiscussions)}>
|
<List.Item title={intl.formatMessage(messages.githubdiscussions)}>
|
||||||
<a
|
<a
|
||||||
href="https://github.com/sct/overseerr/discussions"
|
href="https://github.com/sct/overseerr/discussions"
|
||||||
|
@@ -195,6 +195,7 @@
|
|||||||
"components.Settings.SettingsAbout.Releases.viewchangelog": "View Changelog",
|
"components.Settings.SettingsAbout.Releases.viewchangelog": "View Changelog",
|
||||||
"components.Settings.SettingsAbout.Releases.viewongithub": "View on GitHub",
|
"components.Settings.SettingsAbout.Releases.viewongithub": "View on GitHub",
|
||||||
"components.Settings.SettingsAbout.clickheretojoindiscord": "Click here to join our Discord server.",
|
"components.Settings.SettingsAbout.clickheretojoindiscord": "Click here to join our Discord server.",
|
||||||
|
"components.Settings.SettingsAbout.documentation": "Documentation",
|
||||||
"components.Settings.SettingsAbout.gettingsupport": "Getting Support",
|
"components.Settings.SettingsAbout.gettingsupport": "Getting Support",
|
||||||
"components.Settings.SettingsAbout.githubdiscussions": "GitHub Discussions",
|
"components.Settings.SettingsAbout.githubdiscussions": "GitHub Discussions",
|
||||||
"components.Settings.SettingsAbout.helppaycoffee": "Help pay for coffee",
|
"components.Settings.SettingsAbout.helppaycoffee": "Help pay for coffee",
|
||||||
|
Reference in New Issue
Block a user