Archive Lit 1 API content so we can upgrade generator for Lit 2 & 3#1087
Archive Lit 1 API content so we can upgrade generator for Lit 2 & 3#1087AndrewJakubowicz merged 4 commits intomainfrom
Conversation
|
A live preview of this PR will be available at the URL(s) below. https://pr1087-3825ba2---lit-dev-5ftespv5na-uc.a.run.app/ |
|
Note: This change has caused the API documentation to vanish from the Lit 1 navigation. Otherwise it seems to be working. The navigation works correctly however this has made me realize this is a very difficult change - because the built html depends on JavaScript and other built stuff. |
We are currently blocked at upgrading our API documentation for v2 and v3 because the v1 docs prevent us from updating the generator (due to TypeScript version of the old repos). By archiving the old documentation into unchanging data, we can upgrade the tooling to update our v2 and add v3 docs without the burden of updating lit-html-1 and lit-element-1 repositories.
AndrewJakubowicz
force-pushed
the
update-docs
branch
from
aac44a0 to
3825ba2
Compare
| @@ -0,0 +1,319 @@ | |||
| --- | |||
There was a problem hiding this comment.
This is a copy of the api.html layout (so v1 docs that never change again stay in sync with their layout that never changes). And we can still update newer docs with newer layouts.
AndrewJakubowicz
changed the title
|
I do not think it's worth keeping the config around. They are available via source control if needed. Almost immediately after updating TypeScript and TypeDoc the old configurations no longer work at all. It also appears I may need to change the generator further to work for Lit v2 & v3. Especially because Lit.dev will need to be able to build Lit v3 which uses TypeScript 5.0 |
|
Shouldn't this PR include |
|
No - because they are unchanged. They haven't been changed in 2 years: https://github.com/lit/lit.dev/tree/main/packages/lit-dev-api/api-data |
|
@AndrewJakubowicz thanks! I forgot they were already checked-in 😊 |
|
Added README - PTAL @justinfagnani Edit: Can contribute updates to the README in a follow up commit. |
3 participants
This PR unblocks updating our Lit v2 API generator (so it's not 10 months out of date) & moves towards unblocking the generation of Lit v3 docs.
Why is documentation generation blocked?
lernabecause we pull in an old version of Lit 2).Issues:
How this PR helps?
pages.jsonandsymbols.jsonbuilt data for the v1 repos.This means we no longer build the old documentation and it is essentially frozen. To allow us to continue updating the data of the newer repos I've split out the
apitemplate toapi-v1so it can also remain frozen.Testing plan
Tested by manually opening up the preview URL and checking that the Lit 1 api docs look good. They should look good because they use a perfect fork of the layout & the data is unchanged... and may never change again :P
Part of #1086