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.

Sign up for GitHub

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

Jump to bottom

Docs/docusaurus #1488

Merged
merged 5 commits into from Apr 23, 2022
Merged

Docs/docusaurus #1488

merged 5 commits into from Apr 23, 2022

Conversation

jspizziri
Copy link
Collaborator

An overhaul of the existing documentation website with Docsaurus, reorganized existing documentation to be more digestable, fixed broken links.

@jspizziri jspizziri requested a review from dcvz as a code owner April 22, 2022 20:26
@jspizziri
Copy link
Collaborator Author

@dcvz this PR would technically supersede this one #1487 if you want to move this direction.

For the record I think it's a massive improvement. You can run it locally and take a look. The reorg makes things easier to find and understand, we'll be able to easily integrate with Algolia for doc searching (which will be really nice), and a few other nice things.

Let me know your thoughts.

One thing I wanted to confirm is I think we can remove the iOS Enable Swift Modules instructions here https://react-native-track-player.js.org/install/

As I'm fairly certain I didn't do that last time I setup a project, but I could be forgetting.

dcvz
dcvz previously approved these changes Apr 22, 2022
View reviewed changes
Copy link
Contributor

@dcvz dcvz left a comment

Choose a reason for hiding this comment

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

huge PR ✨ I think this is a great improvement! Amazing job! :)
Left some small comments and some design notes below.

Also one question, will this automatically deploy via our Github CI jut like the current one?

Some design notes:

  • Logo seems to not render correctly?
  • We don't need both the logo and the title I'd say, just logo would work.

Screenshot 2022-04-22 at 22 59 39

docs/docusaurus.config.js Outdated Show resolved Hide resolved
docs/docusaurus.config.js Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@jspizziri
Copy link
Collaborator Author

jspizziri commented Apr 22, 2022 •
edited

@dcvz

I fixed the logo issue and a few others, including your feedback.

Also one question, will this automatically deploy via our Github CI just like the current one?

So TBH I'm not sure how the current one is deploying. Not sure I have visibility into that. But here's what I do know

cd docs && yarn build will generate a static website located at docs/build. The files there just need to be pushed to the CDN.

@jspizziri jspizziri mentioned this pull request Apr 22, 2022
Closed
dcvz
dcvz previously approved these changes Apr 22, 2022
View reviewed changes
Copy link
Contributor

@dcvz dcvz left a comment

Choose a reason for hiding this comment

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

LGTM 👍

docs/docusaurus.config.js Outdated Show resolved Hide resolved
@dcvz
Copy link
Contributor

dcvz commented Apr 22, 2022

@jspizziri I'm actually also not sure how the current one is deploying 👯
But I found this article about deploying docasaurus in Github Pages:
https://evantay.com/blog/docusaurus-gh-action/

@dcvz
Copy link
Contributor

dcvz commented Apr 22, 2022 •
edited

@jspizziri looks like Github automatically deploys your docs if you're using Jekkyl: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site

https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#static-site-generators

@jspizziri
Copy link
Collaborator Author

Here's the docs on gh pages for docusaurus

https://docusaurus.io/docs/deployment#deploying-to-github-pages

I can take a look at it on Monday.

@jspizziri
Copy link
Collaborator Author

jspizziri commented Apr 23, 2022 •
edited

@dcvz I just pushed some new workflows based on the docusaurus documentation with gh-actions. I think it will work. There's a test workflow in there for whenever someone makes a PR to main.

The test deploy ran and failed (because I had some broken links in the docs, so that means it's working). I pushed a fix and it is passing now. I think that should mean we're good to go.

@jspizziri jspizziri force-pushed the docs/docusaurus branch 2 times, most recently from 4c83744 to 65d9695 Compare April 23, 2022 11:38
dcvz
dcvz previously approved these changes Apr 23, 2022
View reviewed changes
Copy link
Contributor

@dcvz dcvz left a comment •
edited

Choose a reason for hiding this comment

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

Amazing work here @jspizziri. Let's merge it! Feel free to do the honours :)

@jspizziri
Copy link
Collaborator Author

I'm going to check one more thing. There might be some special config for js.org. I think there needs to be a change file which I deleted.

@jspizziri
Copy link
Collaborator Author

jspizziri commented Apr 23, 2022 •
edited

@dcvz I had to push the CNAME file which got removed in the refactor, fixed the GmbH., and removed a "TODO" I had regarding the Swift Module thing. That's all that changed. I can merge once you hit the approve button again.

@jspizziri jspizziri requested a review from dcvz April 23, 2022 17:34
dcvz
dcvz approved these changes Apr 23, 2022
View reviewed changes
Copy link
Contributor

@dcvz dcvz left a comment

Choose a reason for hiding this comment

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

Let's ship it!

@jspizziri jspizziri merged commit a961c22 into doublesymmetry:main Apr 23, 2022
dcvz added a commit that referenced this pull request Apr 24, 2022
@dcvz
Squashed commit of the following:
572f65d 
commit 2bbe60a
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Sun Apr 24 09:56:56 2022 +0200

    Bump async from 2.6.3 to 2.6.4 in /example (#1491)

    Bumps [async](https://github.com/caolan/async) from 2.6.3 to 2.6.4.
    - [Release notes](https://github.com/caolan/async/releases)
    - [Changelog](https://github.com/caolan/async/blob/v2.6.4/CHANGELOG.md)
    - [Commits](caolan/async@v2.6.3...v2.6.4)

    ---
    updated-dependencies:
    - dependency-name: async
      dependency-type: indirect
    ...

    Signed-off-by: dependabot[bot] <support@github.com>

    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

commit 146238d
Author: David Chavez <david@dcvz.io>
Date:   Sun Apr 24 09:49:01 2022 +0200

    Update workflows

commit 1095f66
Author: Jacob Spizziri <jacob.spizziri@gmail.com>
Date:   Sun Apr 24 02:23:25 2022 -0500

    docs(workflow): update the build directory as it isn't contextualized by the working-directory (#1492)

commit a961c22
Author: Jacob Spizziri <jspizziri@weare5stones.com>
Date:   Sat Apr 23 18:37:21 2022 -0500

    Docs/docusaurus (#1488)

    * docs(readme): refactor the organization and styling of the documentation

    * docs(readme): add myself as a contributor 😀

    * docs(readme): add documentation about contributing

    * docs(readme): update the community/discord section

    * docs(docs): migration of documentation to docusaurus

commit 90fc0e7
Author: Jacob Spizziri <jspizziri@weare5stones.com>
Date:   Thu Apr 14 14:03:16 2022 +0000

    chore(stale-bot): add a github workflow for stale PR's and issues (#1471)
@jspizziri jspizziri deleted the docs/docusaurus branch April 29, 2022 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dcvz dcvz dcvz approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@jspizziri @dcvz