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

Updating link to project docs #31

Merged
merged 6 commits into from
Mar 27, 2024
Merged

Updating link to project docs #31

merged 6 commits into from
Mar 27, 2024

Conversation

mrl280
Copy link
Collaborator

@mrl280 mrl280 commented Mar 27, 2024

Description:
Updated link to project docs.

Outstanding Sub-Issues:
We will need to host several versions of the docs simultaneously.

Tips for the Reviewer:
No functional changes and nothing to test.

Checklist:
Please be sure to check all boxes honestly. This is to ensure a smooth development process, and to reduce the
likelihood of needing to make additional changes later on.

  • I understand that changes authored by individuals who have not signed a Contributor License Agreement (CLA),
    or whose authorship we cannot verify, may not be accepted.
  • These contribution address a triaged issue.
  • I have performed a self-review of my code and my changes generate no new warnings.
  • I have included unit tests for my code contributions, and all tests are passing.
  • The docstrings are complete, include doctests demonstrating usage, and are properly formatted.
    I have verified that any updates to the project documentation are complete and look okay.
  • I have confirmed all my code contributions are formatted in accordance with the project's Flake8, Black,
    and isort style configurations.
  • No unnecessary changes have been made to the Poetry lock file, but pyproject.toml and the Poetry lock file
    have been updated to reflect any dependency changes.
  • I acknowledge that upon the submission of this pull request, Qoherent will assume the copyright for this
    contribution.

@mrl280 mrl280 requested a review from UmairK5669 March 27, 2024 16:05
Copy link
Member

@UmairK5669 UmairK5669 left a comment

Choose a reason for hiding this comment

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

In pyproject.toml the docs URL is prefixed with https and in other files it's http, nothing major and doesn't break the URL either way so approving as is. If we do decide to change it, my preference would be to stick with https as it shows security and is consistent with other URLs on the page.

@mrl280 mrl280 merged commit 3d78dda into main Mar 27, 2024
2 of 3 checks passed
@mrl280 mrl280 deleted the doc-link-fixes branch March 27, 2024 17:59
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.

2 participants