Skip to content

Conversation

@mrubens
Copy link
Collaborator

@mrubens mrubens commented Feb 12, 2025

Build failed on #24


Important

Adds GitHub Actions workflow for Docusaurus build and fixes a broken link in documentation.

  • GitHub Actions:
    • Adds .github/workflows/docusaurus-build.yml to automate Docusaurus site build on push and pull_request to main.
    • Includes steps for Node.js setup, dependency installation, site build, and PR status update.
  • Documentation:
    • Fixes broken link in docs/advanced-usage/prompt-engineering.md from ./context-mentions to ../basic-usage/context-mentions.

This description was created by Ellipsis for 6458ec6. It will automatically update as commits are pushed.

@mrubens mrubens merged commit 672b9ae into main Feb 12, 2025
2 checks passed
@mrubens mrubens deleted the fix_broken_links branch February 12, 2025 20:16
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested. Reviewed everything up to 6458ec6 in 2 minutes and 14 seconds

More details
  • Looked at 68 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 4 drafted comments based on config settings.
1. .github/workflows/docusaurus-build.yml:48
  • Draft comment:
    Please add a newline at the end of the file to comply with code style requirements enforced by Prettier.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50%
    According to the rules, we shouldn't comment on things that would be automatically caught by tools. Since Prettier is mentioned in the rules as a required tool that should run automatically on commits, this issue would be automatically fixed. The comment is therefore redundant.
    Prettier might not be set up correctly in this repository yet, so this could be a valid reminder to fix the tooling.
    Even if Prettier isn't set up yet, according to the rules we should not comment on things that should be caught by automated tools - instead, we should ensure the tools are properly configured.
    The comment should be deleted as it addresses an issue that should be handled automatically by Prettier, which our rules specify should be set up for all projects.
2. docs/advanced-usage/prompt-engineering.md:11
  • Draft comment:
    Verify that the updated relative link to 'Context Mentions' correctly reflects the current file structure.
  • Reason this comment was not posted:
    Confidence changes required: 50% <= threshold 50%
    None
3. .github/workflows/docusaurus-build.yml:48
  • Draft comment:
    There is no trailing newline at the end of the file. Please add one to comply with standard formatting practices.
  • Reason this comment was not posted:
    Marked as duplicate.
4. docs/advanced-usage/prompt-engineering.md:11
  • Draft comment:
    Updated the relative link from './context-mentions' to '../basic-usage/context-mentions'. Please verify that the new path correctly resolves to the intended file.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is asking the PR author to verify the correctness of a path change, which is against the rules. It does not provide a specific suggestion or point out a clear issue with the code.

Workflow ID: wflow_GxFX1EXfXhj5C7ru


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

uses: actions/github-script@v6
with:
script: |
const { owner, repo, number } = context.issue;
Copy link
Contributor

Choose a reason for hiding this comment

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

The destructuring extracts 'number' from context.issue but it's not used anywhere. Consider removing it to keep the code clean.

Suggested change
const { owner, repo, number } = context.issue;
const { owner, repo } = context.issue;

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.

1 participant