-
Notifications
You must be signed in to change notification settings - Fork 11
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
Check MDX frontmatter #96
Conversation
🌿 Preview your docs: https://cohere-preview-6b4929d5-e298-4a26-9889-ec7a3f343a14.docs.buildwithfern.com |
🌿 Preview your docs: https://cohere-preview-e5200bc1-e60d-4b16-a987-fbb7cfdbcf2b.docs.buildwithfern.com |
🌿 Preview your docs: https://cohere-preview-1a021ac0-7c5f-4fe2-9d73-2627bcb49b04.docs.buildwithfern.com |
🌿 Preview your docs: https://cohere-preview-9ddf2531-67dc-41df-8b55-64ff75d765a6.docs.buildwithfern.com |
🌿 Preview your docs: https://cohere-preview-d4a4041d-c0c4-4520-a932-c827f402a78c.docs.buildwithfern.com |
Signed-off-by: Kate Sv <[email protected]>
🌿 Preview your docs: https://cohere-preview-5637daf2-fb23-4524-928a-24ebb6c762fd.docs.buildwithfern.com |
🌿 Preview your docs: https://cohere-preview-e2f807a6-a894-4e09-9408-21865e0cb5f8.docs.buildwithfern.com |
Signed-off-by: Kate Sv <[email protected]>
🌿 Preview your docs: https://cohere-preview-9167cb2f-7b65-4037-81b1-4317560e4ec7.docs.buildwithfern.com |
…here-ai/cohere-developer-experience into kate-check-meta-data-for-docs
🌿 Preview your docs: https://cohere-preview-b6f1a1f7-2e88-4ef8-a2b6-ca3ece762ec2.docs.buildwithfern.com |
🌿 Preview your docs: https://cohere-preview-4e2a1a04-09db-47ab-bff0-3d8eebea1b63.docs.buildwithfern.com |
…experience into kate-check-meta-data-for-docs
🌿 Preview your docs: https://cohere-preview-807c74f5-d30a-485c-83ac-833b617f8ae7.docs.buildwithfern.com |
🌿 Preview your docs: https://cohere-preview-038fc663-8783-42a8-90c8-acc0664d80bf.docs.buildwithfern.com |
🌿 Preview your docs: https://cohere-preview-556226fe-36b2-461c-99cf-ce3abced7eb2.docs.buildwithfern.com |
🌿 Preview your docs: https://cohere-preview-f962a7eb-b358-45a4-b754-4ffdd571a652.docs.buildwithfern.com |
🌿 Preview your docs: https://cohere-preview-3465eb81-190e-47c3-b5e6-f0347dd550a1.docs.buildwithfern.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔥 Nice!
Co-authored-by: Shubham Shukla <[email protected]> Signed-off-by: Kate Sv <[email protected]>
🌿 Preview your docs: https://cohere-preview-4bb07aaf-325e-4f9d-9954-8e371fa594eb.docs.buildwithfern.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome!
This PR introduces a new script,
check-mdx-frontmatter.js
, which is designed to validate the frontmatter of MDX files in thefern/pages
directory. The script ensures that each MDX file has a description in its frontmatter and that the description length falls within the specified range of 50 to 160 characters.The script is integrated into the GitHub Actions workflow,
check-mdx-frontmatter.yml
, which runs on pull requests targeting themain
branch. The workflow checks out the repository, sets up pnpm, installs dependencies, and then executes thecheck-mdx-frontmatter.js
script.Additionally, the PR updates the
package.json
andpnpm-lock.yaml
files to include thegray-matter
package as a dependency, ensuring that the required package is available for the script to function correctly.check-mdx-frontmatter.js
for validating frontmatter of MDX files.check-mdx-frontmatter.yml
to run the new script on pull requests.gray-matter
added topackage.json
andpnpm-lock.yaml
.fern/pages/responsible-use/security.mdx
has been modified.