Skip to content
This repository was archived by the owner on Feb 13, 2026. It is now read-only.

Documentation Update: Fixing typos, adding notes, and updating links#3248

Closed
carlos-cecnn12 wants to merge 5 commits intomainfrom
updating-docs
Closed

Documentation Update: Fixing typos, adding notes, and updating links#3248
carlos-cecnn12 wants to merge 5 commits intomainfrom
updating-docs

Conversation

@carlos-cecnn12
Copy link
Contributor

@carlos-cecnn12 carlos-cecnn12 commented Mar 11, 2025

Description

This pull request includes several updates to the documentation:

  • Corrected various typos to improve readability and accuracy.
  • Added informative notes to provide additional context and clarity.
  • Updated outdated links to ensure they point to the correct resources.
    These changes aim to enhance the overall quality and usability of the documentation for all users.

@carlos-cecnn12 carlos-cecnn12 requested a review from a team as a code owner March 11, 2025 20:15
<img alt="Amiibo Lookup Panel" src={useBaseUrl('img/docs/feature-development/lookup-panel.png ')} width="75%" variant="centered"/>

:::info
This will only be visible once you register the workflow in the `clutch.config.js` file, this is done in the Configuration section of this guide.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we have a link to the mentioned section here?

0.212 Pre-flight checks satisfied!
0.213 cd backend && go run cmd/assets/generate.go ../frontend/packages/app/build && go build -tags withAssets -o ../build/clutch -ldflags="-X main.version=0.0.0"
0.218 go: errors parsing go.mod:
0.218 /go/src/github.com/lyft/clutch/backend/go.mod:3: invalid go version '1.23.0': must match format 1.23
Copy link
Contributor

Choose a reason for hiding this comment

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

Seems to me we could do with just the error message instead of the log snippet for readability. And then do something like If the make backend build fails with ERROR_MSG, modify the golang version...

➤ YN0000: │ peerDependencies:
➤ YN0000: │ react: ^17.0.2
➤ YN0000: │
➤ YN0028: │ The lockfile would have been modified by this install, which is explicitly forbidden.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same concern on having the log snippet vs the error message

@github-actions
Copy link

This PR has been marked as stale after 7 or more days of inactivity. Please have a maintainer add the on hold label if this PR should remain open. If there is no further activity or the on hold label is not added, this PR will be closed in 3 days.

@github-actions github-actions bot added the stale Issue hasn't had activity in awhile label Mar 21, 2025
@github-actions github-actions bot closed this Mar 25, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

stale Issue hasn't had activity in awhile

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants