Skip to content

fix(docs): update broken and redirected documentation links#2081

Open
nuthalapativarun wants to merge 3 commits into
cocoindex-io:mainfrom
nuthalapativarun:fix/doc-broken-links
Open

fix(docs): update broken and redirected documentation links#2081
nuthalapativarun wants to merge 3 commits into
cocoindex-io:mainfrom
nuthalapativarun:fix/doc-broken-links

Conversation

@nuthalapativarun

Copy link
Copy Markdown
Contributor

Summary

  • Fix two 404 msgspec URLs in serialization.mdx (moved from jcristharif.com/msgspec/ to msgspec.dev)
  • Fix redirected turbopuffer URL in turbopuffer.mdx (/docs/schema/docs/write)
  • Fix transferred instructor repo link in multi-codebase-summarization.md (jxnl/instructor567-labs/instructor)

Test Plan

  • Verify all updated URLs resolve correctly

🤖 Generated with Claude Code

@Haleshot Haleshot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for fixing these! I was going to fix these specific links when I got notified from the link checker CI.

The v1 branch no longer exists since v1 became the main branch,
causing 404s in the link checker.
## Attributes

Row attributes are schemaless; turbopuffer infers attribute types from the values you write. Supported scalar types include `string`, `int`, `uint`, `float`, `bool`, `uuid`, and `datetime`, plus their array variants. See [Turbopuffer's schema reference](https://turbopuffer.com/docs/schema) for the full list.
Row attributes are schemaless; turbopuffer infers attribute types from the values you write. Supported scalar types include `string`, `int`, `uint`, `float`, `bool`, `uuid`, and `datetime`, plus their array variants. See [Turbopuffer's schema reference](https://turbopuffer.com/docs/write) for the full list.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done — added the #schema anchor.

slug: multi-codebase-summarization
image: https://cocoindex.io/blobs/docs-v1/img/examples/multi-codebase-summarization/cover.png
tags: [llm, structured-data-extraction]
last_reviewed: 2026-04-20

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

pls remove this

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

there's a separate file for reviewed time meta

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Removed — reverted this whole file back to the version on main, only keeping the instructor link fix.


```bash
pip install 'cocoindex>=1.0.2' instructor litellm pydantic
pip install 'cocoindex>=1.0.0' instructor litellm pydantic

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

regression plese review

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Reverted, thanks for catching this.

@badmonster0 badmonster0 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ptal on comments

Comment on lines +128 to +151
@@ -141,20 +136,19 @@ async def app_main(
continue
project_name = entry.name

files = [
f
async for f in localfs.walk_dir(
files = list(
localfs.walk_dir(
entry,
recursive=True,
path_matcher=PatternFilePathMatcher(
included_patterns=["**/*.py"],
excluded_patterns=["**/.*", "**/__pycache__"],
included_patterns=["*.py"],
excluded_patterns=[".*", "__pycache__"],
),
)
]
)

if files:
await coco.mount(
coco.mount(

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

All these changes are not right. Seems they're from an older version?

The left side is consistent with the current version:

@coco.fn
async def app_main(
root_dir: pathlib.Path,
output_dir: pathlib.Path,
) -> None:
"""
Main application function.
Scans subdirectories of root_dir, treating each as a Python project,
and generates markdown documentation for each.
"""
# List subdirectories (each is a project)
for entry in root_dir.resolve().iterdir():
# Skip non-directories and hidden directories
if not entry.is_dir() or entry.name.startswith("."):
continue
project_name = entry.name
# Walk Python files in this project, excluding .venv directories
files = [
f
async for f in localfs.walk_dir(
entry,
recursive=True,
path_matcher=PatternFilePathMatcher(
included_patterns=["**/*.py"],
excluded_patterns=["**/.*", "**/__pycache__"],
),
)
]
if files:
# Mount a component to process this project
await coco.mount(
coco.component_subpath("project", project_name),
process_project,
project_name,
files,
output_dir,
)

Similar for all changes below.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

You're right, this was an unintended regression that got pulled in. Reverted the whole file to main and re-applied only the instructor link fix this PR is about.

```python title="main.py"
@coco.fn
async def app_main(
@coco.function

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This should be @coco.fn

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed by reverting the file to main, which restores @coco.fn.

- Add #schema anchor to turbopuffer write docs link
- Revert unrelated regression in multi-codebase-summarization.md
  (accidentally introduced via merge), keep only the instructor link fix

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants