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

Restructure docs/doc-source #75

Open
drnikko opened this issue Jul 26, 2021 · 1 comment
Open

Restructure docs/doc-source #75

drnikko opened this issue Jul 26, 2021 · 1 comment
Assignees

Comments

@drnikko
Copy link
Owner

drnikko commented Jul 26, 2021

problem: the structure of the repo is confusing, setting up local environments is time-consuming (and thus a barrier to participation).

details: This repo was initially built for developers to pull in programatically into their projects, and so we needed a way to have the "raw" text of the questions and answers and also a pleasant, human-readable website version for people who aren't comfortable/don't need to be in github. Thus, the docs vs docs-source current configuration.

what's next: I'd love to start a conversation about how to change this and figure out what the priorities are moving forward.

Thanks to @lee0c for revitalizing the issue about this in #74

@lee0c
Copy link
Contributor

lee0c commented Jul 26, 2021

For the current layout, a simple directory naming change may make all the difference. Something like src/source and site/website/gh-pages (if it's hosted in github pages, idk) - indicates that one folder is unambiguously the source of the info, and the other is primarily files for the website.

I've seen there's some other issues proposing a machine-readable format like json, which would probably not play well with the source vs site structure I proposed right above - I'm not sure how inclusion of json would change either the stored files or the build process for the site. Would it replace some or all of the source material, or live alongside? If alongside, is it a separate top-level directory (Sphinx could probably ignore it in the build, so it could live in the current source directory - but that might be confusing?)

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

2 participants