Minor changes to collections docs #612
Merged
Conversation
This file contains 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
7 tasks
josephjclark
reviewed
Dec 6, 2024
adaptors/collections.md
Outdated
|
|
||
| When running in the CLI, a Personal Access Token can be used to get access to | ||
| the collection (generated from the app at /profile/tokens). | ||
|
|
||
| See the [Collections](/documentation/build/collections) Platform Docs to learn | ||
| more about Collections. | ||
| Learn more about collections and common use cases [here](/documentation/build/collections). |
There was a problem hiding this comment.
Hey, in formal technical documentation, I don't think it's appropriate to use here as link text. What is here? Where does the link go? It's needlessly mysterious: better to clearly signpost what we're linking to.
It's usually better to use the page title (even if it might drift out of date over time). But since this page is also called Collections it's probably better to maybe say Collections Documentation or even Main Collections Documentation
There was a problem hiding this comment.
uhmm.. will review and push again. Thanks
josephjclark
approved these changes
Dec 24, 2024
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.
Short Description
A one or two-sentence description of what this PR does.
Closes #
Details
Add any more details that may be relevant to the reviewer. How did you approach
these docs? Are there any parts you struggled with, or that need particularly
careful review?
AI Usage
Please disclose how you've used AI in this work (it's cool, we just want to
know!):
You can read more details in our
Responsible AI Policy