Skip to content

Remove outputting md files to AppVeyor artifacts#16736

Merged
seanbudd merged 2 commits into
masterfrom
remMdFiles
Jun 26, 2024
Merged

Remove outputting md files to AppVeyor artifacts#16736
seanbudd merged 2 commits into
masterfrom
remMdFiles

Conversation

@seanbudd

@seanbudd seanbudd commented Jun 25, 2024 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Link to issue number:

None

Summary of the issue:

Previously, markdown files were built as an intermittent step between converting text2tags content to HTML.
During this period, it was useful for builds to upload their markdown files as AppVeyor artifacts in the builds system.
We have now removed the t2t content in favour of a markdown source of truth, meaning that the artifact uploaded should be the same as the contents in the PR.

Description of user facing changes

Remove userGuide and changes markdown files from build artifacts

Description of development approach

Remove userGuide and changes markdown files from build artifacts

Also removed other deprecated code and updated remaining references to t2t

Testing strategy:

Test build results

Known issues with pull request:

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

  • Bug Fixes

    • Addressed an issue related to NVDA compatibility in the documentation styles.

  • Documentation

    • Updated comments for clarity and future migration notes in the user documentation.
    • Simplified and consolidated styling for definition lists in the user documentation.

  • Refactor

    • Removed obsolete command dependencies to streamline build processes.
    • Improved handling of TITLE and SETTINGS_SECTION commands for better readability and maintainability.

@seanbudd seanbudd requested a review from a team as a code owner June 25, 2024 04:39
@seanbudd seanbudd requested a review from michaelDCurran June 25, 2024 04:39
@coderabbitai

coderabbitai Bot commented Jun 25, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The recent updates streamline documentation and styling, focusing on removing outdated commands and refining styles for better compatibility. The sconstruct file no longer declares certain documentation commands, while keyCommandsDoc.py has refined its command handling logic. Changes in styles.css aim to simplify and enhance accessibility.

Changes

Files Change Summary
sconstruct Removed declaration and dependencies related to changesMDFile and userGuideMDFile commands.
user_docs/keyCommandsDoc.py Modified Command class logic, removed t2tRegex method, updated handling for TITLE and SETTINGS_SECTION commands, and revised comments.
user_docs/styles.css Consolidated and simplified styling for definition lists, updated comments, and addressed NVDA compatibility issues.
Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e57d7e5 and 9c67765.

Files selected for processing (3)
  • sconstruct (1 hunks)
  • user_docs/keyCommandsDoc.py (3 hunks)
  • user_docs/styles.css (1 hunks)
Files skipped from review due to trivial changes (2)
  • sconstruct
  • user_docs/styles.css
Additional context used
Path-based instructions (1)
user_docs/keyCommandsDoc.py (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.

Pattern **/*.py: _, pgettext, ngettext, and ngettext are defined globally, errors for this being undefined can be ignored.

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.

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.

@seanbudd seanbudd requested a review from gerald-hartig June 25, 2024 23:24
coderabbitai[bot]
coderabbitai Bot reviewed Jun 25, 2024
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Comment thread user_docs/keyCommandsDoc.py
Comment thread user_docs/keyCommandsDoc.py
@seanbudd seanbudd merged commit 2471a56 into master Jun 26, 2024
@seanbudd seanbudd deleted the remMdFiles branch June 26, 2024 02:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@michaelDCurran michaelDCurran Awaiting requested review from michaelDCurran michaelDCurran is a code owner automatically assigned from nvaccess/developers

2 more reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@gerald-hartig gerald-hartig gerald-hartig approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@seanbudd @gerald-hartig