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

Move documentation into Docusaurus #1291

Merged
merged 9 commits into from
Mar 30, 2022
Merged

Move documentation into Docusaurus #1291

merged 9 commits into from
Mar 30, 2022

Conversation

scarroll32
Copy link
Member

Move context of the Wiki and README into a GitHub pages site powered by Docusaurus.

Closes #871

@scarroll32 scarroll32 self-assigned this Mar 28, 2022
@scarroll32 scarroll32 changed the title WIP: Move documentation into Docusaurus Move documentation into Docusaurus Mar 29, 2022
@scarroll32
Copy link
Member Author

Having a small problem with the logo, but otherwise this is ready to merge and I'll then set up a GitHub pages site. @deivid-rodriguez

Warning was

```
[WARNING] Docusaurus config validation warning. Field "url": the url is not supposed to contain a sub-path like '/ransack', please use the baseUrl field for sub-paths

```

The values were filled from what I understood needs to be done from
reading https://docusaurus.io/docs/deployment#deploying-to-github-pages
@deivid-rodriguez
Copy link
Contributor

@scarroll32 I looks very good! I added a few changes to fix the logo and to show docs in home page instead of a 404.

@deivid-rodriguez
Copy link
Contributor

I also updated the configuration to what I think needs to be for GitHub Pages deployment. I think the docs-website folder needs to be configured through Github's UI, but I'm not 100% sure.

@scarroll32
Copy link
Member Author

I also updated the configuration to what I think needs to be for GitHub Pages deployment. I think the docs-website folder needs to be configured through Github's UI, but I'm not 100% sure.

Thank you @deivid-rodriguez I can take it from here 🤝

@scarroll32 scarroll32 merged commit 0c009d1 into main Mar 30, 2022
@scarroll32 scarroll32 deleted the documentation branch March 30, 2022 18:16
@scarroll32 scarroll32 mentioned this pull request Mar 30, 2022
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.

Merge Wiki and README into a GitHub Pages site
2 participants