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

[WIP] Big Docs Update™ #479

Merged
merged 56 commits into from
Apr 15, 2018
Merged

[WIP] Big Docs Update™ #479

merged 56 commits into from
Apr 15, 2018

Conversation

resir014
Copy link
Member

@resir014 resir014 commented Mar 25, 2018

Closes #473.

TODO

  • Ditched Sphinx and replaced with Docusaurus
  • Convert docs pages from .rst to .md (Some Sphinx-related components are converted to raw HTML).
  • Convert any old codedoc-based documentation blocks into valid JSDoc.
  • Update any possibly-outdated bits in the documentation.
  • Add custom styles for Docusaurus site

@resir014
Copy link
Member Author

@dtinth It seems like overriding the Docusaurus CSS is quite simple to do. Will look more into it tomorrow, it's way past midnight here.

Copy link
Member

@dtinth dtinth left a comment

Choose a reason for hiding this comment

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

This is looking great! Thanks so much for your effort.

@dtinth
Copy link
Member

dtinth commented Mar 25, 2018

By the way, should we make package.json a Yarn workspace?

This allows the deps for both the main project and website to be installed in one go. Additionally, it will pave the way for us to centralize the build and publishing system for Bemuse-related packages (for example, the bms, bmson, bemuse-notechart, bemuse-indexer and bemuse-tools packages can be centralized into this monorepo and benefit from the main project’s build (and documentation) system. Furthermore, general-purpose packages such as impure-react, omni-input, sampling-master and scintillator can be turned into npm packages without the overhead of separating projects.)

@resir014
Copy link
Member Author

@dtinth Yeah, sure!

@resir014
Copy link
Member Author

Also, another thing that I forgot to add with the Docusaurus conversion is that MathJax parsing no longer works. Will have to convert them to images or inlined in code blocks

@dtinth
Copy link
Member

dtinth commented Mar 26, 2018

That’s fine, we can add MathJax script (or KaTeX) to the page as well.

@resir014
Copy link
Member Author

resir014 commented Mar 26, 2018

@dtinth Alright, I've added the MathJax scripts on the Docusaurus config. It now works normally again.

image

@resir014
Copy link
Member Author

Current progress:

image

image

We still need to change the placeholder images (e.g. header, footer logo) when I've finished doing my thing with the styles

@resir014
Copy link
Member Author

@dtinth Ready for initial design feedback. After that, I'll do some quick cleanup, then it's up to you to fill up/update the contents and replace the placeholder images.

@dtinth
Copy link
Member

dtinth commented Mar 26, 2018

I have set up Yarn workspace and set up the build process to also generate the documentation site.

For this PR, the result can be previewed at: https://deploy-preview-479--bemuse.netlify.com/project/

When deployed to production, the URL will be https://bemuse.ninja/project/

The pathname /project/ is up to discussion, but I think it makes more sense than https://bemuse.ninja/bemuse/. Since bemusic.github.io has been aliased to bemuse.ninja, they are the same domain and bemusic.github.io cannot be used separately...


The design looks great! While I preview, I think the logo is the wrong variant? (There is a variant for use on Dark background and Light background.)

Also, I prefer the navbar color to be a bit more saturated, e.g. rgb(227, 78, 122).

Thanks!

@dtinth
Copy link
Member

dtinth commented Mar 26, 2018

@resir014
Copy link
Member Author

@dtinth Yeah, we can definitely merge some content from the wiki to the new docs site! After the merging, we can simply disable the wiki.

@resir014
Copy link
Member Author

Alright, I've attempted merging contents for the music server guide from the wiki to the docs page.

Anyways, once this is finished, I might create a PR on the Docusaurus repo to have this project included on their showcase. :D

@dtinth
Copy link
Member

dtinth commented Apr 15, 2018

I think this is ready to merge. Thanks for your help pushing the new documentation website! ^_^

@dtinth dtinth merged commit e50562a into master Apr 15, 2018
@resir014 resir014 deleted the 473-big-docs-update branch October 3, 2018 00:40
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.

2 participants