Add descriptions for project settings

[chacha912]

What this PR does / why we need it?

This PR adds descriptions to the project settings page to improve user understanding of each setting's purpose and impact.

• Added descriptions for Auth webhook URL and methods
• Explained the Client Deactivate Threshold
• Included links to relevant documentation

Any background context you want to provide?

What are the relevant tickets?

Fixes #164

Checklist

• Added relevant tests or not required
• Didn't break anything

Summary by CodeRabbit

• New Features

  • Introduced new styling for links with the addition of .page_link and .icon_link classes, enhancing visual representation.
  • Added instructional text in the Settings interface to improve user guidance on specific settings.

• Bug Fixes

  • Adjusted font properties in the .guide class across multiple stylesheets for improved readability.

• Style

  • Updated font sizes and weights for the .guide class to enhance visual presentation.
  • Reorganized CSS structure for the .webhook class for better clarity.

[coderabbitai]

Walkthrough

The pull request introduces styling modifications to several SCSS files related to the admin settings pages, specifically enhancing the .guide class for improved readability. Additionally, it reorganizes the CSS structure in the admin_setting_project.scss file by replacing a nested class and adding new classes for better visual representation. The Settings.tsx file is updated to improve code readability and user guidance through the addition of instructional text in the UI.

Changes

Files	Change Summary
src/assets/styles/pages/admin_setting_*.scss	Modified .guide class font size and weight; introduced new styles for .page_link and .icon_link.
src/features/projects/Settings.tsx	Reformatted code for readability; added instructional text in the UI; adjusted indentation for consistency.

Assessment against linked issues

Objective	Addressed	Explanation
Add descriptive UI element for settings in the Dashboard (#164)	✅

🐰 In the land of code where the rabbits play,
New styles emerge to brighten the day.
With guides that are clear and links that do shine,
User experience blossoms, oh how divine!
Hops of delight in each line of the code,
A whimsical journey on this joyful road! 🌼✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between af50b23 and 9fa6334.

Files ignored due to path filters (1)

• public/assets/icons/icon_link.svg is excluded by !**/*.svg

Files selected for processing (4)

• src/assets/styles/pages/admin_setting_account.scss (1 hunks)
• src/assets/styles/pages/admin_setting_project.scss (3 hunks)
• src/assets/styles/pages/admin_setting_team.scss (1 hunks)
• src/features/projects/Settings.tsx (10 hunks)

Files skipped from review due to trivial changes (2)

• src/assets/styles/pages/admin_setting_account.scss
• src/assets/styles/pages/admin_setting_team.scss

Additional comments not posted (12)

src/assets/styles/pages/admin_setting_project.scss (2)

Line range hint 127-132: LGTM!

The changes to the .guide class are approved.

---

Line range hint 196-257: LGTM!

The changes to the .webhook class and the addition of the .page_link and .icon_link classes are approved.

src/features/projects/Settings.tsx (10)

70-73: LGTM!

The changes to improve code readability are approved.

---

Line range hint 112-138: LGTM!

The changes to improve code readability are approved.

---

213-214: LGTM!

The changes to improve code consistency are approved.

---

234-246: LGTM!

The addition of instructional paragraphs to enhance the user experience is approved.

---

271-272: LGTM!

The changes to improve code consistency are approved.

---

285-288: LGTM!

The addition of instructional paragraphs to enhance the user experience is approved.

---

289-327: LGTM!

The changes to improve code consistency are approved.

---

338-349: LGTM!

The addition of instructional paragraphs to enhance the user experience is approved.

---

366-367: LGTM!

The changes to improve code consistency are approved.

---

385-386: LGTM!

The changes to improve code consistency are approved.

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 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.

[hackerwins]

Thanks for your contribution.