Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

set typedoc revision to main #34

Merged
merged 1 commit into from
Jul 27, 2023
Merged

set typedoc revision to main #34

merged 1 commit into from
Jul 27, 2023

Conversation

yisding
Copy link
Contributor

@yisding yisding commented Jul 26, 2023

In theory this will stop the API docs thrashing on every build.

Of course, there is a drawback in that if main changes but we haven't released a new version of the docs yet the links will go out of date.

So longer term we might want to investigate some kind of variable where we can continue to have up to date revs but keep the rev in a single variable somewhere:

facebook/docusaurus#395

In the meantime much smaller commits will be a relief

In theory this will stop the API docs thrashing on every build.

Of course, there is a drawback in that if main changes but we haven't
released a new version of the docs yet the links will go out of date.

So longer term we might want to investigate some kind of variable where
we can continue to have up to date revs but keep the rev in a single
variable somewhere:

facebook/docusaurus#395

In the meantime much smaller commits will be a relief
@vercel
Copy link

vercel bot commented Jul 26, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
llama-index-ts-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 26, 2023 6:15am

@yisding
Copy link
Contributor Author

yisding commented Jul 26, 2023

(not so) hilarious thing: I just checked the deployments and for all the thrashing we were doing to the git commits the links weren't even making it into the final API docs. Even though they're in the .md files something strips the github links out at the end.

Not going to investigate because it's probably for the best anyways.

@yisding
Copy link
Contributor Author

yisding commented Jul 27, 2023

Going to merge now (huge QoL issue)

@yisding yisding merged commit 672dde6 into main Jul 27, 2023
1 check passed
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.

1 participant