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

chore: Style and SEO updates #3775

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Conversation

robin-norwood
Copy link
Collaborator

Update titles, descriptions, and page headers to comply with style guide and optimize for SEO

Related issue

IPE-982

Description

This updates the CDKTF documentation per our style guide and SEO optimization guidelines.

Checklist

  • I have updated the PR title to match CDKTF's style guide
  • I have run the linter on my code locally
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation if applicable
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works if applicable
  • New and existing unit tests pass locally with my changes

Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

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

Looks good! Left suggestions for ensuring consistency across title and h1s, but feel free to ignore anything that doesn't feel good!

website/docs/cdktf/api-reference/csharp/index.mdx Outdated Show resolved Hide resolved
website/docs/cdktf/api-reference/go/index.mdx Outdated Show resolved Hide resolved
website/docs/cdktf/api-reference/go/index.mdx Outdated Show resolved Hide resolved
website/docs/cdktf/api-reference/go/index.mdx Outdated Show resolved Hide resolved
website/docs/cdktf/api-reference/index.mdx Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/performance.mdx Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/performance.mdx Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/project-setup.mdx Outdated Show resolved Hide resolved
website/docs/cdktf/create-and-deploy/remote-templates.mdx Outdated Show resolved Hide resolved
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.

4 participants