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

Fix documentation #523

Merged
merged 3 commits into from
Feb 3, 2025
Merged

Fix documentation #523

merged 3 commits into from
Feb 3, 2025

Conversation

jbigot
Copy link
Member

@jbigot jbigot commented Jan 24, 2025

Fix documentation

  • Fix the sidepanel
  • Fix the link to the GitHub repo

List of things to check before making a PR

Before merging your code, please check the following:

  • you have added a line describing your changes to the Changelog;
  • you have added unit tests for any new or improved feature;
  • In case you updated dependencies, you have checked pdi/docs/CheckList.md
  • you have checked your code format:
    • you have checked that you respect all conventions specified in CONTRIBUTING.md;
    • you have checked that the indentation and formatting conforms to the .clang-format;
    • you have documented with doxygen any new or changed function / class;
  • you have correctly updated the copyright headers:
    • your institution is in the copyright header of every file you (substantially) modified;
    • you have checked that the end-year of the copyright there is the current one;
  • you have updated the AUTHORS file:
    • you have added yourself to the AUTHORS file;
    • if this is a new contribution, you have added it to the AUTHORS file;
  • you have added everything to the user documentation:
    • any new CMake configuration option;
    • any change in the yaml config;
    • any change to the public or plugin API;
    • any other new or changed user-facing feature;
    • any change to the dependencies;
  • you have correctly linked your MR to one or more issues:
    • your MR solves an identified issue;
    • your commit contain the Fix #issue keyword to autoclose the issue when merged.

* Fix the sidepanel
* Fix the link to the GitHub repo

Fix #521
Fix #522
@jbigot jbigot changed the title Fix sidepanel Fix documentation Jan 24, 2025
@jbigot jbigot self-assigned this Jan 24, 2025
README.md Outdated Show resolved Hide resolved
Co-authored-by: Jacques Morice <[email protected]>
README.md Outdated Show resolved Hide resolved
@jbigot jbigot requested a review from jmorice91 January 29, 2025 10:03
@jbigot jbigot requested review from benoitmartin88, JAuriac and Yushan-Wang and removed request for benoitmartin88, JAuriac and Yushan-Wang January 29, 2025 10:20
@jbigot jbigot enabled auto-merge (squash) January 30, 2025 13:15
Copy link
Member

@benoitmartin88 benoitmartin88 left a comment

Choose a reason for hiding this comment

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

LGTM

@jbigot jbigot changed the base branch from main to v1.8 February 3, 2025 15:56
@jbigot jbigot disabled auto-merge February 3, 2025 15:58
@jbigot jbigot merged commit 1738e4f into v1.8 Feb 3, 2025
@jbigot jbigot deleted the fix_sidepanel branch February 3, 2025 16:00
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.

Website for version 1.8 has an incorrect repo link Website is still missing side panel
5 participants