Skip to content

Comments

chore(documentation): fixed bug in doc publishing#720

Merged
james-rl merged 1 commit intomainfrom
james/nested-docs
Feb 20, 2026
Merged

chore(documentation): fixed bug in doc publishing#720
james-rl merged 1 commit intomainfrom
james/nested-docs

Conversation

@james-rl
Copy link
Contributor

@james-rl james-rl commented Feb 20, 2026

User description

⚠️ PR Title Must Follow Conventional Commits

Format: feat[optional scope]: <description>

Examples: feat: add new SDK method · feat(storage): support file uploads · feat!: breaking API change


Description

Fixes SDK doc publishing workflow

Motivation

There was a bug that caused github docs to nest previous versions, so the file size ended up growing exponentially. This removes the bug but there's still some one-time cleanup work to perform

Changes

Testing

  • Unit tests added
  • Integration tests added
  • Smoke Tests added/updated
  • Tested locally

Breaking Changes

Checklist

  • PR title follows Conventional Commits format (feat: or feat(scope):)
  • Documentation updated (if needed)
  • Breaking changes documented (if applicable)

CodeAnt-AI Description

Fix doc publishing to stop nesting previous versions in gh-pages

What Changed

  • Tar archives for existing and new docs are created without dereferencing symbolic links to preserve correct file structure
  • Artifacts are extracted directly and the workflow now removes any legacy ./docs/docs directory left by previous malformed extractions
  • The publish job now avoids re-adding nested docs trees before committing the merged documentation

Impact

✅ No nested documentation trees in gh-pages
✅ Smaller gh-pages repository size after publish
✅ Fewer repeated documentation files and commits

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

@codeant-ai
Copy link
Contributor

codeant-ai bot commented Feb 20, 2026

CodeAnt AI is reviewing your PR.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@james-rl james-rl requested review from alb-rl and dines-rl February 20, 2026 18:30
@codeant-ai codeant-ai bot added the size:S This PR changes 10-29 lines, ignoring generated files label Feb 20, 2026
@codeant-ai
Copy link
Contributor

codeant-ai bot commented Feb 20, 2026

CodeAnt AI finished reviewing your PR.

@james-rl james-rl merged commit 1eeb486 into main Feb 20, 2026
8 checks passed
@james-rl james-rl deleted the james/nested-docs branch February 20, 2026 18:33
@stainless-app stainless-app bot mentioned this pull request Feb 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:S This PR changes 10-29 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants