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

WIP issue: Potential reorganization #34

Open
5 of 6 tasks
karmanyaahm opened this issue Oct 19, 2021 · 3 comments
Open
5 of 6 tasks

WIP issue: Potential reorganization #34

karmanyaahm opened this issue Oct 19, 2021 · 3 comments

Comments

@karmanyaahm
Copy link
Member

karmanyaahm commented Oct 19, 2021

Idk what this is worth, but I'm pretty sure our documentation is not easy enough to digest for most people. Some random thoughts for now, i'll turn this into a more coherent idea later:

  • Add different sections for distributor user and self-hoster
    • This would also help with Add troubleshooting instructions #33 in some capacity if troubleshooting instructions for hosters were different from just regular android users
    • This would also simplify the introduction for non-hosters
  • Make different stages of the diagram/definitions?
    • Might help with people who want to understand how UP works but don't want to super deeply understand everything
    • For example most users don't need to bother that connector libraries and end-user applications are different things
  • import stuff from UnifiedPush/contrib onto the docs
  • common proxies docs could potentially be imported here? No

not so much directly documentation but:

  • Perhaps make a Matrix space
  • then different rooms for users, hosters, troubleshooting, announcements, library developer, core developer etc

S1m edit:
Add checkbox

@karmanyaahm
Copy link
Member Author

make different stages of the diagram/definitions?

Mostly done in #61

import stuff from UnifiedPush/contrib onto the docs

done

common proxies docs could potentially be imported here?

no

@p1gp1g
Copy link
Member

p1gp1g commented Jul 21, 2022

We may check the diagram task now ?

@karmanyaahm
Copy link
Member Author

The first one, different sections, is more or less done. They're not separate categories, but the current state of things is good rn imo.

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