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

Website for configuration documentation #186

Open
junkurihara opened this issue Sep 16, 2024 · 8 comments
Open

Website for configuration documentation #186

junkurihara opened this issue Sep 16, 2024 · 8 comments

Comments

@junkurihara
Copy link
Owner

As I mentioned in #165.

I actually know the current README.md and config-example.toml are not user-friendly, especially for the upstream_options. So I think we should prepare a website of the documentation of rxpy configuration.

Any opinion?

@junkurihara
Copy link
Owner Author

junkurihara commented Sep 19, 2024

Webpage repo: https://github.com/junkurihara/rpxy-web
Just created and not yet deployed.

@Gamerboy59
Copy link
Contributor

Gamerboy59 commented Sep 22, 2024

I suggest renaming the repo to rpxy-docs so there is no confusion with rpxy-webui (web and webui is very similar).

@junkurihara
Copy link
Owner Author

@Gamerboy59 Agree. Will change it.

Or else, should we put it in ./docs directory of this repo?

@Gamerboy59
Copy link
Contributor

Where the website is stored depends on the scope of the docs imo. Comprehensive documentation is usually placed in a separate repository for better management of multiple files, their relationships and to handle issues, pull requests, and versioning independently from the main application. A single-page documentation fits in a subfolder.
You favored a more complete documentation in #165 hence I'd vote to keep it in a separated repo and see to which size the docs will grow. I think tools like MkDocs or Docusaurus can be used together with Github Actions in Github Pages so the website generation can be slightly automated. Tools like Hugo can be used for automation if we are not going to use a documentation website framework. I haven't extensively tried either of them yet.

@junkurihara
Copy link
Owner Author

junkurihara commented Oct 2, 2024

@Gamerboy59 Thanks! (and sorry for my delayed reply)

I just deployed a skeleton of rpxy documentation website from https://github.com/junkurihara/rpxy-docs with Hugo. Now the skeleton is hosted on https://rpxy.io.

I have used the framework, but I completely forgot how to configure it. So, it took a time.

Anyways, I will update and add content of the documentation repo.

@junkurihara
Copy link
Owner Author

oh... Should I move to rpxy.org or rpxy.net just in case?

https://www.theverge.com/2024/10/8/24265441/uk-treaty-end-io-domain-chagos-islands

@Gamerboy59
Copy link
Contributor

Gamerboy59 commented Oct 13, 2024

Hi @junkurihara I've read about this .io Domain problem too but I doubt it'll have a big impact for now. They still make good money from this domain extension so I suppose they'll find an organization which continoues it.
Also, I really like the design of the docs website, flat and clean. I need to get used to Hugo again too, then I'll send PR with some content as well. Nice work so far. :)

@junkurihara
Copy link
Owner Author

Hi @Gamerboy59

I agree with you for the io domain, so let us keep it as is for now.

Thanks for checking the docs! I am gradually updating the docs, but it is slow and I need time to write new content. So PR is really welcome!!

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