Skip to content

Massive documentation overhaul#1665

Open
xenova wants to merge 75 commits into
mainfrom
ai-skills
Open

Massive documentation overhaul#1665
xenova wants to merge 75 commits into
mainfrom
ai-skills

Conversation

@xenova

@xenova xenova commented Apr 25, 2026

Copy link
Copy Markdown
Collaborator
  • replace jsdoc-to-markdown dependency with custom parser for finer control
  • fix broken links
  • improve + update docs
  • upgrade build process
  • add agents.md and skills

opening PR early to get early feedback and to get docs previews

@nico-martin

Copy link
Copy Markdown
Collaborator

Did some deep dive and I really, really like this solution!
Especially the "partial generation" in skills where the skill itself is "handwritten" but then there are the @generated:-Tags that are written by the generator.
What would be the next steps for this?

@xenova

xenova commented May 1, 2026

Copy link
Copy Markdown
Collaborator Author

Thanks! I'll be cleaning things up in the next couple of days (aiming to merge next week).

I just want to make 100% sure all links stay backwards compatible, but things are much cleaner now than they used to be. Also, cuts down on many dependencies, which is nice.

@xenova xenova requested a review from nico-martin May 9, 2026 18:10
* @param {number|bigint} item The item to search for in the tensor
* @returns {number} The index of the first occurrence of item in the tensor data.
*/
indexOf(item) {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is this intentional?
Tensor is exported from the main entry point. That means users could have used Tensor.indexOf(), removing it could cause errors. Imo at least a breaking change.

@xenova xenova May 12, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, this was intentional -- Tensor.indexOf actually hasn't been used anywhere in the library for a very long time and probably should have been removed in 4.0 😅 No external code snippets of ours have ever mentioned it either, and has no analogue really to pytorch tensor classes.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I see. But I'm still not completely sold on the idea of removing public facing methods in a minor update without prior deprecation warning.

Yes, we dont use it ourselfs. But its possible someones app relies on it and now gets syntax errors.
We can go ahead with it if you think the risk is negligible. But we definitely shouldn't do something like that on a whim.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

But we definitely shouldn't do something like that on a whim.

Oh yes 100% agree -- this is a very minor exception that was an internal method which hasn't been used/exposed for quite some time 😅 So, indeed, the risk is negligible.

@xenova xenova changed the title [WIP] Massive documentation overhaul Massive documentation overhaul May 12, 2026
@xenova xenova mentioned this pull request Jun 6, 2026

@nico-martin nico-martin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

There's still an issue with docs-validate. Other than that, the PR looks pretty good!

Comment thread packages/transformers/docs/source/_toctree.yml
@nico-martin nico-martin self-assigned this Jun 8, 2026
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.

3 participants