Skip to content

fix: update default share image and front matter#370

Merged
hazel-nut merged 22 commits intomainfrom
tech/config-clean-up
Jan 14, 2026
Merged

fix: update default share image and front matter#370
hazel-nut merged 22 commits intomainfrom
tech/config-clean-up

Conversation

@hazel-nut
Copy link
Copy Markdown
Contributor

summary

  • update the default share image:

    • remove manual deep links to the old cdn from front matter and upload the image to this repo
    • delete unnecessary og:image front matter and set the default share image in the site config
  • remove unnecessary meta tag front matter:

    • og:title and twitter:title are set from title
    • og:description and twitter:description are set from description
    • og:url is generated automatically from the canonical URL, which is built from the page URL
  • remove permalink front matter because it doesn't do anything (page URLs are determined by path and filename)

testing

  • compare the meta tags in page source from builds off this branch with meta tags in prod and see that they're the same
  • build locally, change a permalink, and see that the URL of the page doesn't change
  • make sure the new share image is correctly being served

Copy link
Copy Markdown
Contributor

@mikemimik mikemimik left a comment

Choose a reason for hiding this comment

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

A different approach to a wide change like this, might be to contain it to a single folder and it's sibling translation folders. This way we can validate the change on a small scale, and then introduce many smaller pull-requests all introducing the same change to limit the risk of each pull-request.

@hazel-nut what do you think about decomposing this pull-request into many smaller pull-requests?

@mikemimik mikemimik added documentation Improvements or additions to documentation main-docs Changes related to auth0's main docs (https://auth0.com/docs) labels Dec 3, 2025
@hazel-nut hazel-nut force-pushed the tech/config-clean-up branch from d487462 to 20f0380 Compare December 3, 2025 21:06
@hazel-nut
Copy link
Copy Markdown
Contributor Author

@mikemimik not an issue if you prefer. i broke up this PR into more granular commits per top-level docs directory to give you an idea of each diff with that approach. if that seems okay to you, i can close this PR and open a dozen or so smaller corresponding ones.

mikemimik
mikemimik previously approved these changes Jan 14, 2026
Copy link
Copy Markdown
Contributor

@mikemimik mikemimik left a comment

Choose a reason for hiding this comment

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

LGTM; full disclosure, I did not review each file. As we spoke about internally, this PR is the result of running an automated command against the corpus of documents to create an output.

@mikemimik mikemimik changed the title upload default share image, remove unnecessary meta tag front matter fix: update default share image and frontmatter Jan 14, 2026
@hazel-nut hazel-nut changed the title fix: update default share image and frontmatter fix: update default share image and front matter Jan 14, 2026
@hazel-nut hazel-nut merged commit fbee7ce into main Jan 14, 2026
4 of 5 checks passed
@hazel-nut hazel-nut deleted the tech/config-clean-up branch January 14, 2026 20:19
daniloasis-auth0 pushed a commit to daniloasis-auth0/docs-v2 that referenced this pull request Jan 23, 2026
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 main-docs Changes related to auth0's main docs (https://auth0.com/docs)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants