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

Consider the website as documentation, not programming #1041

Merged
merged 1 commit into from
Feb 9, 2025
Merged

Conversation

Nuru
Copy link
Contributor

@Nuru Nuru commented Feb 9, 2025

what

  • Mark the website source as documentation, not programming

why

  • Atmos is a tool written in go
  • The website is documentation, written in MDX and JavaScript, supporting the tool
  • Language statistics should reflect the tool, not the documentation

Summary by CodeRabbit

  • Chores
    • Enhanced classification for support materials, ensuring all documentation and web content are accurately recognized.
    • Refined processing for sample files to improve consistency.

@Nuru Nuru added documentation Improvements or additions to documentation no-release Do not create a new release (wait for additional code changes) labels Feb 9, 2025
@Nuru Nuru requested review from osterman and aknysh February 9, 2025 18:06
@Nuru Nuru requested a review from a team as a code owner February 9, 2025 18:06
Copy link
Contributor

coderabbitai bot commented Feb 9, 2025

📝 Walkthrough

Walkthrough

This change updates the .gitattributes configuration to adjust how certain files are classified. The modifications now mark every file under the docs and website directories as documentation for the linguist tool. In addition, the golden snapshot file pattern has been updated by removing the -text attribute, thereby altering how line-ending conversions are handled. No changes were made to the binary file declarations or merge conflict settings.

Changes

File(s) Change Summary
.gitattributes (docs/, website/) Updated patterns to mark all files in the docs and website directories as documentation.
.gitattributes (tests/snapshots/**/*.golden) Removed the -text attribute from the golden snapshot pattern, changing text normalization behavior.

Suggested reviewers

  • osterman

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 845aeb5 and 2b6956e.

📒 Files selected for processing (1)
  • .gitattributes (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build (macos-latest, macos)
  • GitHub Check: Build (windows-latest, windows)
  • GitHub Check: Analyze (go)
  • GitHub Check: Summary
🔇 Additional comments (3)
.gitattributes (3)

4-4: Clarify Documentation Classification for 'docs' Directory
The updated recursive pattern "docs/** linguist-documentation" neatly ensures all files in the docs directory are classified as documentation. Nice and clear change that aligns with the PR objectives.


5-5: Classify Website Files as Documentation
The new entry "website/** linguist-documentation" correctly marks every file under the website directory as documentation. This change directly reflects the intent to separate the programming language statistics from documentation.


10-12: Verify Golden Snapshot Attribute Handling
The PR summary indicates the golden snapshot files should no longer have the "-text" attribute to adjust line-ending behavior. However, line 11 still shows "-text". Please double-check if the removal was intended or if this attribute should be updated accordingly.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 or @auto-summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

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.

@aknysh aknysh merged commit e7897bf into main Feb 9, 2025
46 of 48 checks passed
@aknysh aknysh deleted the linguist branch February 9, 2025 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation no-release Do not create a new release (wait for additional code changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants