Skip to content

docs: add new APDL resource link to learning and update external links#4067

Merged
germa89 merged 2 commits intomainfrom
doc/adding-link-to-apdl-article
Jul 2, 2025
Merged

docs: add new APDL resource link to learning and update external links#4067
germa89 merged 2 commits intomainfrom
doc/adding-link-to-apdl-article

Conversation

@germa89
Copy link
Collaborator

@germa89 germa89 commented Jul 2, 2025

Description

Add a post about APDL.

Issue linked

NA

Checklist

Summary by Sourcery

Add a new APDL learning resource link and update external links in documentation

Documentation:

  • Add APDL resource link to the learning section
  • Update external links in links.rst to latest URLs

Copilot AI review requested due to automatic review settings July 2, 2025 09:17
@germa89 germa89 requested a review from a team as a code owner July 2, 2025 09:17
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@germa89 germa89 self-assigned this Jul 2, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 2, 2025

Reviewer's Guide

This PR enriches the documentation by adding a new APDL resource entry to the learning guide and refreshing several external links to their current URLs.

File-Level Changes

Change Details Files
Add APDL resource link to learning overview
  • Insert new bullet entry pointing to the APDL post
  • Include the APDL resource in the learning toctree list
doc/source/getting_started/learning.rst
Update external resource URLs
  • Replace outdated external URLs with their updated counterparts
  • Adjust link text for consistency and clarity
doc/source/links.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @germa89 - I've reviewed your changes - here's some feedback:

  • Add the new APDL post to the learning section’s toctree so it appears in the sidebar navigation.
  • Include a brief description for the APDL resource in learning.rst to provide context instead of only a link.
  • Check that the external links in links.rst adhere to the project’s reference link style and update any inconsistencies.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Add the new APDL post to the learning section’s toctree so it appears in the sidebar navigation.
- Include a brief description for the APDL resource in learning.rst to provide context instead of only a link.
- Check that the external links in links.rst adhere to the project’s reference link style and update any inconsistencies.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a new APDL learning resource to the “Recommended articles” section and reorganizes the external links in links.rst.

  • Added an APDL article reference in learning.rst
  • Resorted and updated external link anchors in links.rst

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
doc/source/links.rst Alphabetized and updated external link definitions
doc/source/getting_started/learning.rst Added APDL learning link under Recommended articles
Comments suppressed due to low confidence (1)

doc/source/getting_started/learning.rst:205

  • Indent the new APDL bullet and its accompanying link to match the existing styling (two spaces before the * and four spaces before the link line).
* APDL: The Language of Simulation.

@github-actions github-actions bot added the documentation Documentation related (improving, adding, etc) label Jul 2, 2025
@germa89 germa89 enabled auto-merge (squash) July 2, 2025 10:22
@germa89
Copy link
Collaborator Author

germa89 commented Jul 2, 2025

@pyansys-ci-bot LGTM.

Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot left a comment

Choose a reason for hiding this comment

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

✅ Approving this PR because germa89 said so in here 😬

LGTM

@codecov
Copy link

codecov bot commented Jul 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.03%. Comparing base (eaf5df4) to head (7a29664).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4067   +/-   ##
=======================================
  Coverage   89.02%   89.03%           
=======================================
  Files         187      187           
  Lines       14993    14993           
=======================================
+ Hits        13348    13349    +1     
+ Misses       1645     1644    -1     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89 germa89 merged commit 7574808 into main Jul 2, 2025
78 of 80 checks passed
@germa89 germa89 deleted the doc/adding-link-to-apdl-article branch July 2, 2025 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation related (improving, adding, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants