[DOC] Fix broken discord links #4130
Closed
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
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
hesreallyhim
commented
Apr 7, 2025
.gitignore
Outdated
| testdata | ||
|
|
||
| # Python version | ||
| .python-version |
Contributor
Author
There was a problem hiding this comment.
should i remove?
hesreallyhim
commented
Apr 7, 2025
docs/docs.trychroma.com/package.json
Outdated
| "typescript": "latest" | ||
| } | ||
| }, | ||
| "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e" |
Contributor
Author
There was a problem hiding this comment.
should i remove?
Contributor
Author
There was a problem hiding this comment.
👍 i wasn't sure what to do here because the docs just say to yarn install but yarn is no longer recommended as a global dependency, i ended up just using npm to build it.
jairad26
reviewed
Apr 8, 2025
docs/docs.trychroma.com/package.json
Outdated
| "typescript": "latest" | ||
| } | ||
| }, | ||
| "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e" |
.gitignore
Outdated
| testdata | ||
|
|
||
| # Python version | ||
| .python-version |
docs/docs.trychroma.com/README.md
Outdated
| - [ ] swag element in light/dark mode. eg the graphic on the index route | ||
| - [ ] turn on algolia once indexed | ||
| - [ ] turn back on "edit on github" button when public | ||
| - [x] turn back on "edit on github" button when public |
Contributor
There was a problem hiding this comment.
can we keep the PR about discord links? a lot of the features todo are ood, so we'd want to refresh the whole thing at some point
Contributor
Author
There was a problem hiding this comment.
yeah for sure... it was just one of those things i caught and wanted to quick-fix but it's better to keep the PR focused
jairad26
approved these changes
Apr 11, 2025
jeffchuber
pushed a commit
that referenced
this pull request
Apr 23, 2025
## Description of changes This is just closing the loop on #4130 , which seems to have gotten out of sync with my local branch, so the revision requests I was responding to weren't getting pushed up, so I'll just close that one. Also, I noticed that in the meantime @jeffchuber already merged a PR #4286 with my changes, the only difference being that this adds a link to the channel. 🤷 So this is a really trivial PR, just making it so that I can close out the other one and maybe you like this minuscule enhancement. @jairad26 Co-authored-by: Really Him <hesereallyhim@proton.me>
Contributor
Author
|
This branch got borked. See #4363 |
Inventrohyder
pushed a commit
to Inventrohyder/chroma
that referenced
this pull request
Aug 5, 2025
## Description of changes This is just closing the loop on chroma-core#4130 , which seems to have gotten out of sync with my local branch, so the revision requests I was responding to weren't getting pushed up, so I'll just close that one. Also, I noticed that in the meantime @jeffchuber already merged a PR chroma-core#4286 with my changes, the only difference being that this adds a link to the channel. 🤷 So this is a really trivial PR, just making it so that I can close out the other one and maybe you like this minuscule enhancement. @jairad26 Co-authored-by: Really Him <hesereallyhim@proton.me>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description of changes
Saw this Issue reporting a broken discord link and figured I'd put together a quick fix.
This link - https://discord.gg/rahcMUU5XV - still seems to work, but i think it's from a different owner/inviter. 🤷
Also, I added.python-versionto.gitignorebecause I like to use it for pyenv.Also, I checked off an item on the docs main README TODO's because I think it's completed.Also, when I ranyarnto install, and thenyarn devto run the docs, it made some auto-changes topackage.jsonandnext-env.d.ts. Yarn pins the package manager version to the package.json, which would explain the first change.I also noticed that it looks like the instructions are still using yarn 1 (aka yarn-classic), which is no longer really standard. yarn >=2 made a big change to a plug'n'play type system using
corepack. I would recommend we consider switching that over.Test plan
How are these changes tested?
I ran the docs site locally and verified the broken discord links.
pytestfor python,yarn testfor js,cargo testfor rustDocumentation Changes
Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?