Documentation

Questions
1

For the new release of Openbullet2, a documentation as been created but on the main repo of openbullet I can’t see the source of the docs, so why merging the docs inside the OpenBullet2 repo and so people can contribute to the docs.
Also I wanted to contribute to the docs and add i18n French translation for everyone, and the docs could be updated automatically by a workflow on the github repo.

Edit: Also would be really cool to improve the contributing of the project, so new contributor can come on the project, in general just more appeal for new contributors.
Less work for you (@Ruri) and much more functionality and bug fix.
I’ve many ideas to improve the project like the docs, issue template on github, code of conduct, contributing guide, workflow, etc…
Also… another time, using weblate for a full translation of the project in every language possible would be a really great feature for everyone I think.

2

Hello, the docs are in a separate repo which is currently private. I plan to make it public in a few hours and adding a link to contribute.

The doc framework is docusaurus, I don’t know how i18n works there so you’ll have to look it up yourself if you want to add French translations ^^

If you have any ideas about improving the contributions, feel free to let me know. Thanks!

1 Like
3

Yes adding translation on the docs with docusaurus is really easy that why I wanted to do it, it’s simple but can help everyone.

4

There you go

2 Likes
5

Making a plugins repository, to list multiple plugin would be also a good idea

6

That would take some effort ^^ but yeah it would be cool

7

Everything takes some effort yes but could simplify something for everyone :hugs:

8

Yes I just mean that I don’t think I have enough time for this too, there’s already a huge backlog of GH issues to address, plus some that I still have to create. Sadly I can only work on this in my free time after work hours or sometimes on weekends.

9

Yes, no problem!
Thanks for doing your best for us, the community

1 Like
10

You should put the link of the documentation the docs repo right here:
2.41 KB 👀

And also I don’t ahve the docs anymore like just a black screen when opening the url:
9.95 KB 👀

1 Like
11

I think it’s because I pushed a small fix and it was deploying the new build, try again please.

12

Same, can’t access to the docs.

I have a question, I’m working on the docs and have a question, if someone wants to contact a staff on the forum or you, the project leader, how can we do, like email or so?

13

Okay I redeployed and it works now, weird. Was most likely a surge issue. Anyways you can DM me, the forum has a chat feature (top-right corner).

14

I can’t find the button could you screen it, maybe im dumb :open_hands:

15

Sorry I forgot the chat is only available to users with trust level 1 or higher. I just upgraded you.

1 Like
16

you should rename the docs repositories to something like:

openbullet2-docs rather than OB2Docs

17

Yeah I know, please open an issue about it, I’ll do it sooner or later

1 Like