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

Update minimum requirements #17064

Merged
merged 3 commits into from
Aug 29, 2024
Merged

Update minimum requirements #17064

merged 3 commits into from
Aug 29, 2024

Conversation

CyrilleB79
Copy link
Collaborator

@CyrilleB79 CyrilleB79 commented Aug 27, 2024

Link to issue number:

Closes #17063

Summary of the issue:

NVDA's User Guide specifies a too low amount of minimal disk space for NVDA.

Description of user facing changes

In the User Guide, update minimum required disk space to 200 MB.

While at it, updated the wording for lines above.

Description of development approach

I have chosen the next round value above. But we may use a higher value if needed. E.g.:

  • 250 MB for a higher round value giving more room to future inclusions
  • 300 MB, using a strategy according to which we would double the required value when the previously required value is exceeded.

Testing strategy:

Check generated UG.

Known issues with pull request:

None

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

Summary by CodeRabbit

  • Documentation
    • Updated system requirements for clarity and accuracy.
    • Increased minimum storage space requirement from 150 MB to 500 MB.
    • Clarified support status for 32-bit operating systems.

@AppVeyorBot
Copy link

  • Build execution time has reached the maximum allowed time for your plan (60 minutes).

See test results for failed build of commit f7e5e3e39b

user_docs/en/userGuide.md Outdated Show resolved Hide resolved
@CyrilleB79 CyrilleB79 marked this pull request as ready for review August 28, 2024 13:31
@CyrilleB79 CyrilleB79 requested a review from a team as a code owner August 28, 2024 13:31
Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Walkthrough

The changes involve updating the system requirements in the user documentation, including a significant increase in the minimum storage requirement from 150 MB to 500 MB. Additionally, the support status for 32-bit operating systems has been clarified to enhance user understanding.

Changes

Files Change Summary
user_docs/en/userGuide.md Updated system requirements, increased storage requirement from 150 MB to 500 MB, and clarified support status for 32-bit operating systems.

Assessment against linked issues

Objective Addressed Explanation
System requirements are outdated (#17063)

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 69b9ce4 and 976c830.

Files selected for processing (1)
  • user_docs/en/userGuide.md (1 hunks)
Additional context used
Path-based instructions (1)
user_docs/en/userGuide.md (2)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious. When providing code suggestions, particularly when requested, ensure GitHub's suggestion format is used, i.e.: suggestion <code changes>


Pattern **/*.md: Focus on grammar, spelling, and punctuation. Also consider readability and clarity of contents. Ensure that changes follow the style of one sentence per line, suggest changes if this is not met.

Additional comments not posted (2)
user_docs/en/userGuide.md (2)

46-47: LGTM!

The rephrased note regarding the lack of active support for 32-bit operating systems enhances readability and comprehension.

The code changes are approved.


48-48: LGTM!

The increase in storage requirements from 150 MB to 500 MB reflects a shift towards accommodating more resource-intensive applications.

The code changes 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
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 as 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.

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

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
Member

@Qchristensen Qchristensen 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, thanks Cyrille

@seanbudd seanbudd merged commit 4cd1ae0 into nvaccess:beta Aug 29, 2024
2 checks passed
@github-actions github-actions bot added this to the 2025.1 milestone Aug 29, 2024
@seanbudd seanbudd modified the milestones: 2025.1, 2024.4 Aug 29, 2024
@CyrilleB79 CyrilleB79 deleted the minReq branch September 20, 2024 14:05
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.

4 participants