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

Updated Docs engine #233

Merged
merged 9 commits into from
May 16, 2022
Merged

Updated Docs engine #233

merged 9 commits into from
May 16, 2022

Conversation

yathomasi
Copy link
Contributor

@yathomasi yathomasi commented May 6, 2022

Updated docs engine to use reusable package gatsby-theme-iterative.
The latest [email protected] update iterative/gatsby-theme-iterative#7 does include features requested for cml docs.

Fixes #157
Fixes #187
Fixes #238

A Example usage:
https://cmldev-docsengine.gtsb.io/doc/ref/ci
0ca4d40#diff-2285ff562ca51e66d2c3fc4bc92b4a380b47afab4449dfd2c5a07c221f9d9305

@gatsby-cloud
Copy link

gatsby-cloud bot commented May 6, 2022

Gatsby Cloud Build Report

cml.dev

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 1m

Performance

Lighthouse report

Metric Score
Performance 🔶 67
Accessibility 🔶 84
Best Practices 💚 92
SEO 💚 91

🔗 View full report

@yathomasi yathomasi marked this pull request as ready for review May 12, 2022 11:07
@yathomasi yathomasi requested review from casperdcl and a team May 12, 2022 11:07
const imageSourcePaths = require('./models/image-source-paths')
const github = require('./models/github')
const pruneCache = require('./models/prune-cache')

const models = [markdownContent, docs, imageSourcePaths, github, pruneCache]
const models = [markdownContent, imageSourcePaths, github, pruneCache]
Copy link
Contributor

Choose a reason for hiding this comment

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

I think markdownContent can be removed as well, since nothing aside from docs used it as cml.dev has no blog

Copy link
Contributor

@rogermparent rogermparent left a comment

Choose a reason for hiding this comment

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

Looking good so far! Awesome that it fixes some existing bugs. There could be more scrubbing done to remove what the theme replaces, but that's not a hugely pressing issue.

I did notice the 404 page doesn't have headers or footers though, which would be annoying in specific situations where the user hits 404 without a page to go back to (outdated links, primarily).

@yathomasi
Copy link
Contributor Author

Thanks, @rogermparent.
It looks like we hadn't noticed it earlier https://cml.dev/404.

@julieg18
Copy link
Contributor

It looks like we hadn't noticed it earlier https://cml.dev/404.

Opened an issue! (#238)

@yathomasi
Copy link
Contributor Author

@julieg18 Thanks for opening the issue.
I have pushed changes to fix that as well.

Copy link
Contributor

@rogermparent rogermparent left a comment

Choose a reason for hiding this comment

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

I definitely should have checked production, but thanks for fixing the issue in this PR!

With that done, I'd say this PR is mergeable!

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.

Add header and footer to cml.dev 404 page ref: auto-link options prismjs syntax highllighting
3 participants