Make docs more LLM friendly #29566
Merged
Make docs more LLM friendly #29566
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
neverett
requested changes
Apr 24, 2025
There was a problem hiding this comment.
Sending over the first batch of edits! Once you've incorporated these edits, I can re-review and do another 50 or so.
I also noticed that the space between the front matter and first line of content has been removed -- that should be added back for all files.
docs/docs/dagster-plus/deployment/management/managing-compute-logs-and-error-messages.md
Outdated
Show resolved
Hide resolved
docs/docs/dagster-plus/deployment/management/managing-compute-logs-and-error-messages.md
Outdated
Show resolved
Hide resolved
docs/docs/dagster-plus/deployment/management/settings/customizing-agent-settings.md
Outdated
Show resolved
Hide resolved
…ing-agent-settings.md Co-authored-by: Nikki Everett <neverett@users.noreply.github.com>
Co-authored-by: Nikki Everett <neverett@users.noreply.github.com>
Co-authored-by: Nikki Everett <neverett@users.noreply.github.com>
C00ldudeNoonan
force-pushed
the
anoonan/doc-1101-generate-descriptions-for-non-api-docs
branch
from
5b5157b to
3dce112
Compare
…oc-1101-generate-descriptions-for-non-api-docs
…ing-agent-settings.md Co-authored-by: Nikki Everett <neverett@users.noreply.github.com>
Co-authored-by: Nikki Everett <neverett@users.noreply.github.com>
Co-authored-by: Nikki Everett <neverett@users.noreply.github.com>
…' of github.com:dagster-io/dagster into anoonan/doc-1101-generate-descriptions-for-non-api-docs
neverett
requested changes
Apr 28, 2025
docs/docs/dagster-plus/deployment/management/settings/hybrid-agent-settings.md
Outdated
Show resolved
Hide resolved
docs/docs/dagster-plus/deployment/management/tokens/agent-tokens.md
Outdated
Show resolved
Hide resolved
docs/docs/dagster-plus/deployment/management/tokens/agent-tokens.md
Outdated
Show resolved
Hide resolved
...s/dagster-plus/features/authentication-and-access-control/scim/enabling-scim-provisioning.md
Outdated
Show resolved
Hide resolved
...s/dagster-plus/features/authentication-and-access-control/scim/enabling-scim-provisioning.md
Outdated
Show resolved
Hide resolved
docs/docs/dagster-plus/features/authentication-and-access-control/scim/index.md
Outdated
Show resolved
Hide resolved
docs/docs/dagster-plus/features/authentication-and-access-control/scim/okta-scim.md
Outdated
Show resolved
Hide resolved
docs/docs/dagster-plus/features/authentication-and-access-control/scim/okta-scim.md
Outdated
Show resolved
Hide resolved
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
… sections Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
Signed-off-by: nikki everett <nikki@dagsterlabs.com>
neverett
approved these changes
May 6, 2025
neverett
deleted the
anoonan/doc-1101-generate-descriptions-for-non-api-docs
branch
neverett
added a commit
that referenced
this pull request
May 12, 2025
## Summary & Motivation Added description tag to .md and .mdx pages across the docs to assist in SEO and making the docs more LLM friendly. ## How I Tested These Changes Built docs locally and checked metadata on webpage and description is in head. --------- Signed-off-by: nikki everett <nikki@dagsterlabs.com> Co-authored-by: Nikki Everett <neverett@users.noreply.github.com> Co-authored-by: nikki everett <nikki@dagsterlabs.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary & Motivation
Added description tag to .md and .mdx pages across the docs to assist in SEO and making the docs more LLM friendly.
How I Tested These Changes
Built docs locally and checked metadata on webpage and description is in head.