Skip to content
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

📜 Revise the docs to remain in sync with the current changes #151

Merged
merged 6 commits into from
Jul 19, 2023

Conversation

neon-mmd
Copy link
Owner

What does this PR do?

This PR updates the docs for the project by updating the names of the previous config options and adding and explaining new config option proposed in PR #145 and also updates the explanation of the colorscheme option.

Why is this change important?

This change is essential as it ensures that the docs remain in sync with the current changes.

Author's checklist

  • update the name of redis_connection_url config option.
  • add a new config option upstream_search_engines with the explanation.
  • update the explanation of the config option colorscheme.
  • bump the app version

Related issues

Closes #148

@github-actions
Copy link

github-actions bot commented Jul 18, 2023

🦙 MegaLinter status: ❌ ERROR

Descriptor Linter Files Fixed Errors Elapsed time
❌ ACTION actionlint 7 1 0.05s
❌ CSS stylelint 13 6 1 1.51s
❌ DOCKERFILE hadolint 1 1 0.08s
❌ HTML djlint 13 8 0.88s
⚠️ MARKDOWN markdownlint 14 5 42 1.46s
❌ RUST clippy yes 1 68.9s
❌ SPELL cspell 73 256 29.96s
❌ YAML yamllint 11 1 0.6s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

xffxff
xffxff previously approved these changes Jul 19, 2023
Copy link
Contributor

@xffxff xffxff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, just one small issue needs to be fixed

docs/configuration.md Outdated Show resolved Hide resolved
@neon-mmd
Copy link
Owner Author

neon-mmd commented Jul 19, 2023 via email

@xffxff
Copy link
Contributor

xffxff commented Jul 19, 2023

If you don't mind can you kindly commit this suggestion from your side if possible 🙂 because I am abroad for 9-10 days so I might not be able to do so.

Sure, no problem. Wishing you a pleasant journey.

docs/configuration.md Outdated Show resolved Hide resolved
@xffxff xffxff merged commit 9964be4 into rolling Jul 19, 2023
4 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

📜 Revise the docs to remain in sync with the current changes
2 participants