-
Notifications
You must be signed in to change notification settings - Fork 0
docs: document sentence-case product naming #121
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
Merged
Merged
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| --- | ||
| name: trellis-onboarding | ||
| description: > | ||
| Use when the user asks to onboard to Trellis, set up Trellis, or otherwise mentions onboarding to Trellis. | ||
| Use when the user asks to onboard to trellis, set up trellis, or otherwise mentions onboarding to trellis. | ||
| --- | ||
|
|
||
| Onboard the repo to use Trellis. This includes adding the Trellis config file, converting any existing changelog and | ||
| Onboard the repo to use trellis. This includes adding the trellis config file, converting any existing changelog and | ||
|
|
||
| ## Initial Setup | ||
|
|
||
| First confirm that the project is a Gleam project. If not, explain to the user that Trellis is designed for Gleam projects. | ||
| First confirm that the project is a Gleam project. If not, explain to the user that trellis is designed for Gleam projects. | ||
|
|
||
| Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to Trellis. If they want to switch, clarify that Trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to Trellis. | ||
| Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to trellis. If they want to switch, clarify that trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to trellis. | ||
|
|
||
| ## Migration | ||
|
|
||
| Refer to the documentation for Trellis for instructions on how to migrate existing repos to Trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to Trellis. | ||
| Refer to the documentation for trellis for instructions on how to migrate existing repos to trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to trellis. | ||
|
|
||
| ## Reference | ||
|
|
||
| - Documentation for Trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.com. | ||
| - Documentation for trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| --- | ||
| name: trellis-onboarding | ||
| description: > | ||
| Use when the user asks to onboard to Trellis, set up Trellis, or otherwise mentions onboarding to Trellis. | ||
| Use when the user asks to onboard to trellis, set up trellis, or otherwise mentions onboarding to trellis. | ||
| --- | ||
|
|
||
| Onboard the repo to use Trellis. This includes adding the Trellis config file, converting any existing changelog and | ||
| Onboard the repo to use trellis. This includes adding the trellis config file, converting any existing changelog and | ||
|
|
||
| ## Initial Setup | ||
|
|
||
| First confirm that the project is a Gleam project. If not, explain to the user that Trellis is designed for Gleam projects. | ||
| First confirm that the project is a Gleam project. If not, explain to the user that trellis is designed for Gleam projects. | ||
|
|
||
| Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to Trellis. If they want to switch, clarify that Trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to Trellis. | ||
| Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to trellis. If they want to switch, clarify that trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to trellis. | ||
|
|
||
| ## Migration | ||
|
|
||
| Refer to the documentation for Trellis for instructions on how to migrate existing repos to Trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to Trellis. | ||
| Refer to the documentation for trellis for instructions on how to migrate existing repos to trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to trellis. | ||
|
|
||
| ## Reference | ||
|
|
||
| - Documentation for Trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.com. | ||
| - Documentation for trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| --- | ||
| name: trellis-onboarding | ||
| description: > | ||
| Use when the user asks to onboard to Trellis, set up Trellis, or otherwise mentions onboarding to Trellis. | ||
| Use when the user asks to onboard to trellis, set up trellis, or otherwise mentions onboarding to trellis. | ||
| --- | ||
|
|
||
| Onboard the repo to use Trellis. This includes adding the Trellis config file, converting any existing changelog and | ||
| Onboard the repo to use trellis. This includes adding the trellis config file, converting any existing changelog and | ||
|
|
||
| ## Initial Setup | ||
|
|
||
| First confirm that the project is a Gleam project. If not, explain to the user that Trellis is designed for Gleam projects. | ||
| First confirm that the project is a Gleam project. If not, explain to the user that trellis is designed for Gleam projects. | ||
|
|
||
| Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to Trellis. If they want to switch, clarify that Trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to Trellis. | ||
| Then check the repository for existing tools for managing changelogs, handling releases, and task running. If any of those are found, ask the user if they want to keep using those tools or switch to trellis. If they want to switch, clarify that trellis will take over those responsibilities and that they will need to migrate any existing changelog or release notes to trellis. | ||
|
|
||
| ## Migration | ||
|
|
||
| Refer to the documentation for Trellis for instructions on how to migrate existing repos to Trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to Trellis. | ||
| Refer to the documentation for trellis for instructions on how to migrate existing repos to trellis. Use what you learned from the initial setup to determine if any existing tools need to be migrated or removed. If the user is unsure, provide guidance on how to migrate their existing changelog and release notes to trellis. | ||
|
|
||
| ## Reference | ||
|
|
||
| - Documentation for Trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.com. | ||
| - Documentation for trellis: https://github.com/tylerbutler/trellis/tree/main/website/src/content/docs/docs, also published to https://trellis.tylerbutler.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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.