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
We are looking for a way to document our app, basically creating a product documentation.
We thought to place a README.ME in each of apps relevant src/screens folders and let docusaurus generate a docs static page from it.
We would like to update those README files and commit them to git and re-generate a next documentation for all untagged files in the main branch. Then when its time to release a new app version we tag it and docusaurus could use this new tag to generate a new version of the page.
I found a 3 year old issue asking for a similar feature but it was closed as won't fix without further explanation on why it was closed.
While I guess this will not make it into core could this be implemented as plugin for the docs version generator?
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
We are looking for a way to document our app, basically creating a product documentation.
We thought to place a
README.ME
in each of apps relevantsrc/screens
folders and let docusaurus generate adocs
static page from it.We would like to update those README files and commit them to git and re-generate a
next
documentation for all untagged files in the main branch. Then when its time to release a new app version we tag it and docusaurus could use this new tag to generate a new version of the page.I found a 3 year old issue asking for a similar feature but it was closed as won't fix without further explanation on why it was closed.
While I guess this will not make it into core could this be implemented as plugin for the docs version generator?
Beta Was this translation helpful? Give feedback.
All reactions