You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The general documentation includes a "Development" section, which, unfortunately, has nothing to do with the expected "development of a Piral instance", but rather with the "development of Piral itself".
We need to introduce some terminology to make clear what is what.
Steps to Reproduce
Open docs.piral.io
Go to the first tile - documentation
See "Development" noted in the sidebar / close to the bottom
Expected behavior
The development of Piral itself should maybe be constraint to the GitHub repository, e.g., the README files.
The following strategy could help:
The main README.md (root): informs about repo structure, important pages, services, ... - very quick intro
The README.md of "src" includes the development guide for Piral; referring also to the sub-README files
The README.md of "src/packages" lists these packages, their intentions, and whats necessary for their development + vision
The README.md of "src/pages" again, explains these repositories, their intentions, and vision
Same for README.md of "src/demos"
The README.md of specific packages (e.g., piral-vue) has documentation as accessible as possible for people coming to NPM
Actual behavior
Right now it is quite a mix. Not very user friendly.
Possible Origin / Solution
The documentation is growing and the organization needs to be more strict.
Prerequisites
Environment Details and Version
Using
https://docs.piral.io
.Description
The general documentation includes a "Development" section, which, unfortunately, has nothing to do with the expected "development of a Piral instance", but rather with the "development of Piral itself".
We need to introduce some terminology to make clear what is what.
Steps to Reproduce
docs.piral.io
Expected behavior
The development of Piral itself should maybe be constraint to the GitHub repository, e.g., the README files.
The following strategy could help:
piral-vue
) has documentation as accessible as possible for people coming to NPMActual behavior
Right now it is quite a mix. Not very user friendly.
Possible Origin / Solution
The documentation is growing and the organization needs to be more strict.
cc @lschoett @iotcloudarchitect
The text was updated successfully, but these errors were encountered: