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

docs: rebuild with Vuepress v2 #1221

Open
wants to merge 159 commits into
base: master
Choose a base branch
from
Open

Conversation

DreamOfIce
Copy link

@DreamOfIce DreamOfIce commented Mar 4, 2023

The documentation site is still under construction and contributions are welcome 😃
Site preview: https://corejs-doc.netlify.app

This pull request will move from draft to ready when all of the following todos are completed:

  • Complete the basic layout
  • Porting compatibility page
  • Splitting and optimising the user guide (reuse Split README into files located at /docs #1095 )
  • Splitting and optimising contributions guide
  • Convert types into TypeScript
  • Update the links to the documentation in the project
  • Complete i18n system
  • Chinese translation

close #1053 #1064 #1095

@zloirock
Copy link
Owner

zloirock commented Mar 4, 2023

One note about the compatibility page: unlike the site, it should work in IE9+ to allow testing those engines, but with Vuepress it does not work in IE. It makes sense to add it to this site, however, for testing, it's required to save the current simple table that works everywhere.

@DreamOfIce
Copy link
Author

Can't we just use the version in tests/compat/?

@zloirock
Copy link
Owner

zloirock commented Mar 5, 2023

It's not built and not published on gh-pages, so you should clone the repo, install dependencies, build it, and if you wanna test not a browser locally installed on your computer, upload it to the hosting or VM where you wanna test it - it's not a trivial task for users who wanna check the compatibility of the browser.

@DreamOfIce
Copy link
Author

DreamOfIce commented Mar 5, 2023

It's not built and not published on gh-pages, so you should clone the repo, install dependencies, build it, and if you wanna test not a browser locally installed on your computer, upload it to the hosting or VM where you wanna test it - it's not a trivial task for users who wanna check the compatibility of the browser.

The browser-runner.js in tests/compat should work in IE8, right? I'm going to add it with <script nomodule> to use as a fallback

@DreamOfIce
Copy link
Author

One note about the compatibility page: unlike the site, it should work in IE9+ to allow testing those engines, but with Vuepress it does not work in IE. It makes sense to add it to this site, however, for testing, it's required to save the current simple table that works everywhere.

It should work with IE now

@stydxm
Copy link

stydxm commented May 4, 2023

The document is almost complete except the domain. So can you give us some advice or tell some problems? Thanks.
@zloirock

@DreamOfIce
Copy link
Author

@zloirock The work on this PR is done and I've just resolved all the conflicts once again。
Can we merge as soon as possible?

@Rudxain
Copy link

Rudxain commented May 25, 2023

Hey everyone. I want to apologize for not contributing as much as I promised (even though it was a "soft" promise, not something serious). I've been very busy IRL (and still am), and had no idea how to help (specially since I've never used JS frameworks).

Sorry for being slightly off-topic, and thank you all for your time ✌️

@DreamOfIce
Copy link
Author

@zloirock I've just resolved all the conflicts once again.
Could you review this pr as soon as possible?

@santi100a
Copy link

@DreamOfIce @Rudxain -- please fix merge conflicts.
@zloirock -- please review after the conflicts are resolved.

@Rudxain
Copy link

Rudxain commented Aug 28, 2023

@Rudxain -- please fix merge conflicts.

My HDD died. And even if I could use a PC, I don't have time to spare. And I closed my PR because this PR is the successor

@santi100a
Copy link

It's okay. @DreamOfIce -- please fix conflicts.
@zloirock -- please review after @DreamOfIce fixes merge conflicts.

@Mister-Hope
Copy link

This is the author of vuepress theme hope and vuepress team member, if anyone need my help just mention me in this thread.

@zloirock zloirock force-pushed the master branch 2 times, most recently from dd233e0 to a47114e Compare June 28, 2024 10:45
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.

README is absurdly large and unintuitive
8 participants