📝 Diction introducing/discussing cross-reference materials - #2710
Open
JFWooten4 wants to merge 14 commits into
Open
📝 Diction introducing/discussing cross-reference materials#2710JFWooten4 wants to merge 14 commits into
JFWooten4 wants to merge 14 commits into
Conversation
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Standardizes cross-reference language and adds clearer contextual links across Stellar documentation.
Changes:
- Rewords references using “Learn more” phrasing.
- Adds glossary links to relevant guides and sections.
- Expands Lab XDR conversion callouts.
Recommendation: NEEDS-CHANGES — Correct the XDR type requirements, mislabeled offer references, and remaining glossary inconsistencies.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
docs/tools/lab/view-xdr/xdr-to-json.mdx |
Expands XDR-JSON guidance. |
docs/tools/lab/view-xdr/json-to-xdr.mdx |
Clarifies JSON conversion input. |
docs/tools/lab/view-xdr/diff-xdr.mdx |
Explains XDR comparison format. |
docs/tokens/README.mdx |
Rewords the SAC reference. |
docs/learn/glossary.mdx |
Standardizes and adds related-material links. |
docs/learn/fundamentals/transactions/list-of-operations.mdx |
Rephrases operation cross-references. |
docs/learn/fundamentals/stellar-data-structures/assets.mdx |
Corrects reference punctuation. |
docs/data/indexers/build-your-own/processors/README.mdx |
Corrects reference punctuation. |
docs/data/apis/horizon/api-reference/errors/result-codes/operation-specific/change-trust.mdx |
Corrects reference punctuation. |
docs/data/apis/horizon/api-reference/aggregations/paths/README.mdx |
Corrects reference punctuation. |
docs/build/guides/transactions/claimable-balances.mdx |
Standardizes guide capitalization. |
docs/build/guides/storage/choosing-the-right-storage.mdx |
Rephrases the state archival reference. |
Comments suppressed due to low confidence (1)
docs/learn/fundamentals/transactions/list-of-operations.mdx:183
- This labels every Manage Sell Offer as a passive sell offer, but passive orders have different execution behavior and their own operation. Point this cross-reference to the target page's Manage Sell Offer subsection instead.
Learn more about passive sell offers in our [Liquidity on Stellar section](../liquidity-on-stellar-sdex-liquidity-pools.mdx).
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <noreply@openai.com>
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
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.
From #2437
Like I say there, I think "Learn more about" is a much friendlier way to reference related materials than "see." It gives a next step for the reading, inviting them into the materials for a more complete understanding. I think this documentation style will make it easier for new devs.