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 Build Broken and Confusing #903

Open
Oglopf opened this issue Dec 5, 2023 · 0 comments
Open

Docs Build Broken and Confusing #903

Oglopf opened this issue Dec 5, 2023 · 0 comments

Comments

@Oglopf
Copy link
Contributor

Oglopf commented Dec 5, 2023

I went to do some work on the docs today on a separate machine and was appalled how complicated this setup is for a fresh run. Even with ruby and rake and docker the instructions failed and the error message was cryptic. It worries me that any user who goes to make changes will be quickly discouraged.

Digging into this there's another repo that handles the docs build. I was hoping to find a test build there to ensure things work right, but while there is a github action setup for this, the workflow seems to never run. Why is that?

It's also odd because now i've got an issue spread across 2 repos, i need to build the docs, but i need to check the doc-build-repo to do this? It's confusing and likely to attract issues to this repo that should be there (this issue is partially an example).

I'd like to spend some time with a student and other dev to walk through this and watch and see how simple it is, and then see what we can do to improve on it. Plus, maybe I'm the fool and these are simple to build and I'm missing something.

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

No branches or pull requests

1 participant