Skip to content

Conversation

@josh-wong
Copy link
Member

Description

This PR adds a cautionary notice to the top of docs in the docs folder. Since those docs should now be updated in the scalar-labs/docs-internal repository, the cautionary notice that I've added here is to provide guidance for those who may not know where to update the docs.

Related issues and/or PRs

Changes made

  • Added a cautionary notice to the top of each doc in the docs folder, stating that the doc should be updated in the scalar-labs/docs-internal repository.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • Tests (unit, integration, etc.) have been added for the changes.
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

The docs folder in this repository can be deleted after we have moved all product docs to the scalar-labs/docs-internal repository and confirmed that the migration was a success.

Release notes

N/A

@josh-wong josh-wong added the documentation Improvements or additions to documentation label Jan 30, 2024
@josh-wong josh-wong self-assigned this Jan 30, 2024
Copy link
Collaborator

@feeblefakie feeblefakie left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

Copy link
Collaborator

@jnmt jnmt left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

Copy link

@supl supl left a comment

Choose a reason for hiding this comment

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

LGTM.
Thank you!

@supl supl merged commit f9b0a4d into master Jan 31, 2024
@supl supl deleted the add-note-about-moved-docs branch January 31, 2024 12:09
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants