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.

Sign up for GitHub

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

Jump to bottom

Documentation structure #12

Open
simonsan opened this issue Sep 11, 2023 · 1 comment
Open

Documentation structure #12

simonsan opened this issue Sep 11, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@simonsan
Copy link
Collaborator

Currently, the documentation is more spontaneously structured construct. With some additions to our ecosystem in the near future, that will also get more attention, we should structure our documentation holistically, so that it also accounts for the synergy between them.

Projects that have synergies, from the user POV:

  • rustic
  • rustic-server
  • rustic-scheduler
  • app documentation

Projects that have synergies, from the developers POV:

  • libraries of the various apps
  • the apps themselves
  • the documentation of the libraries
@simonsan simonsan added the enhancement New feature or request label Sep 11, 2023
@simonsan
Copy link
Collaborator Author

simonsan commented Sep 12, 2023 •
edited

Accounted for the informational split between users and devs with creating https://github.com/rustic-rs/dev-docs which is hosting the developer documentation.

Next, I would like to brainstorm topics that we didn't account for in both and open corresponding issues for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@simonsan