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

DocOps: add markdown lint and link checking #24

Merged
merged 3 commits into from
Jan 22, 2024
Merged

DocOps: add markdown lint and link checking #24

merged 3 commits into from
Jan 22, 2024

Conversation

lornajane
Copy link
Collaborator

We don't have any checks on this repo and I shipped a broken link. To help make the right thing the easy thing, this pull request adds markdownlint to check the markdown is valid, and mlc to check the links work.

@lornajane lornajane requested a review from a team January 17, 2024 20:42
@@ -8,7 +8,7 @@ Authors:

OpenAI Actions uses OpenAPI to enable GPTs to make API calls.

It has support for a [consequential flag](https://platform.openai.com/docs/actions/consequential-flag):
It has support for a consequential flag (documentation no longer available, but originally at `https://platform.openai.com/docs/actions/consequential-flag`):

Choose a reason for hiding this comment

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

Not sure about this change

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The link is currently broken, I have no way to know if we should keep it or not - so I did this to it for now. Alternative suggestions are welcome though!

@lornajane lornajane merged commit 943a371 into main Jan 22, 2024
2 checks passed
@lornajane lornajane deleted the add-docs-ci branch January 22, 2024 11:28
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.

None yet

2 participants