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

docs: fixed some errors in documentation #8261

Merged
merged 1 commit into from
Apr 16, 2024
Merged

docs: fixed some errors in documentation #8261

merged 1 commit into from
Apr 16, 2024

Conversation

LisaVCherian
Copy link
Contributor

@LisaVCherian LisaVCherian commented Apr 12, 2024

Change Summary

Corrected typos and improved phrasing of certain sentences for better clarity and readability.

Change type

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Summary by CodeRabbit

  • Documentation
    • Updated keyboard shortcuts in the documentation, changing navigation references from ⌘+K to ⌘+L and ⌘+J.
    • Refined the description of where a starred base appears, now specifically noted in the Starred section on the left sidebar.
    • Clarified that roles assigned at the base level take precedence over workspace-level assignments and corrected the description of the "Owner" role's privileges.
    • Improved the clarity of instructions for overriding member permissions in a workspace by refining language around member roles and permissions.

@CLAassistant
Copy link

CLAassistant commented Apr 12, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

coderabbitai bot commented Apr 12, 2024

Walkthrough

Walkthrough

The recent updates across NocoDB documentation focus on enhancing user understanding and navigation efficiency. Changes include updated keyboard shortcuts, clarified display locations for starred bases, refined descriptions of role precedence, and improved clarity in member permissions instructions. These adjustments ensure users have more precise and accessible information.

Changes

File Path Change Summary
.../040.keyboard-shortcuts.md Updated keyboard shortcuts from ⌘+K to ⌘+L and ⌘+J for different actions.
.../070.actions-on-base.md Clarified that starred bases appear only in the Starred section on the left sidebar.
.../010.roles-permissions-overview.md Roles at the base level take precedence over workspace levels; corrected "Owner" role's privileges.
.../020.base-collaboration.md Enhanced clarity in instructions for overriding member permissions in a workspace.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5f7a298 and 2896355.
Files selected for processing (4)
  • packages/noco-docs/docs/020.getting-started/040.keyboard-shortcuts.md (2 hunks)
  • packages/noco-docs/docs/040.bases/070.actions-on-base.md (1 hunks)
  • packages/noco-docs/docs/110.roles-and-permissions/010.roles-permissions-overview.md (2 hunks)
  • packages/noco-docs/docs/120.collaboration/020.base-collaboration.md (1 hunks)
Additional comments not posted (4)
packages/noco-docs/docs/120.collaboration/020.base-collaboration.md (1)

Line range hint 21-21: Consider adding a preposition to improve the clarity of the sentence.

It seems there might be a missing preposition in the phrase "the member you wish to collaborate." Consider revising it to "the member with whom you wish to collaborate."

packages/noco-docs/docs/040.bases/070.actions-on-base.md (1)

36-36: Clarify the location of the starred base in the documentation.

The update clearly specifies that the starred base will appear in the Starred section on the left sidebar, which enhances user understanding.

packages/noco-docs/docs/110.roles-and-permissions/010.roles-permissions-overview.md (2)

18-18: Clarification on role precedence enhances understanding and avoids potential confusion.


34-34: Updated description of the "Owner" role's privileges correctly outlines critical responsibilities and security measures.


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
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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

Actionable comments outside the diff hunks (7)
packages/noco-docs/docs/120.collaboration/020.base-collaboration.md (2)

Line range hint 20-20: Add a blank line above the heading for better readability and to adhere to markdown best practices.

+ 
## Removing members from your base

Line range hint 28-29: Remove multiple consecutive blank lines to adhere to markdown best practices.

-
-
packages/noco-docs/docs/020.getting-started/040.keyboard-shortcuts.md (2)

Line range hint 61-61: Add a blank line above the heading for better readability and to adhere to markdown best practices.

+ 
## General shortcuts

Line range hint 71-71: Add a blank line above the heading for better readability and to adhere to markdown best practices.

+ 
## Grid view shortcuts
packages/noco-docs/docs/040.bases/070.actions-on-base.md (3)

Line range hint 8-8: Add a blank line above the heading for better readability and to adhere to markdown best practices.

+ 
## Base context menu

Line range hint 13-13: Add a blank line above the heading for better readability and to adhere to markdown best practices.

+ 
## Rename base

Line range hint 25-25: Add a blank line above the heading for better readability and to adhere to markdown best practices.

+ 
## Star base

@@ -6,7 +6,7 @@ keywords: ['NocoDB base', 'base collaboration', 'base context menu', 'base owner
---

## Inviting members to your base
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a blank line above the heading for better readability and to adhere to markdown best practices.

+ 
## Inviting members to your base

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
## Inviting members to your base
## Inviting members to your base

@@ -34,7 +34,7 @@ Access recently visited views quickly using `⌘` + `L` (or `Ctrl` + `L` on Wind

![Recent Views](/img/v2/cmd-l.png)

To navigate within ⌘+K menu,
To navigate within ⌘+L menu,
Copy link
Contributor

Choose a reason for hiding this comment

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

Ensure consistency in list item markers in markdown.

- - Use `↑` `↓` to navigate between listed items
+ * Use `↑` `↓` to navigate between listed items

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
To navigate within ⌘+L menu,
To navigate within ⌘+L menu,
* Use `` `` to navigate between listed items

@@ -49,7 +49,7 @@ This feature is available only in NocoDB Cloud hosted version.

Quickly search through docs from within NocoDB UI using `⌘` + `J` (or `Ctrl` + `J` on Windows). Search results will be displayed in a modal window; click on the result to open the page in a new tab.

To navigate within ⌘+K menu,
To navigate within ⌘+J menu,
Copy link
Contributor

Choose a reason for hiding this comment

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

Ensure consistency in list item markers in markdown.

- - Use `↑` `↓` to navigate between listed items
+ * Use `↑` `↓` to navigate between listed items

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
To navigate within ⌘+J menu,
To navigate within ⌘+J menu,
* Use `` `` to navigate between listed items

@dstala dstala merged commit 134fc3d into develop Apr 16, 2024
1 check was pending
@dstala dstala deleted the doc-edits branch April 16, 2024 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants