💡 [Feature]: Create docs web page for this product #352
Description
🎯 Aim of the feature
Every product needs a place to store documentation. Currently we use GitHub wiki for that which is not the best pick as it is: not indexed so not searchable, the UI is not elastic and the menu may only be sorted in alphabetical order, and it may only be modified by a maintainer (it is impossible to get help from contributors to update it with a PR).
The idea is use GitHub pages and create dedicated Docs web page. Many other PnP products already have it like
https://pnp.github.io/cli-microsoft365/ or https://pnp.github.io/powershell/ or https://pnp.github.io/pnpjs/
The idea is to do something similar and use wiki only to document internal repo processes like pipeline explanation or technical related info. Everything else which is related to extension feature and guidance and usage examples should be moved to the Docs web page.
Before we go about it we need to:
- First check what pages we should have? Should we just recrate what we have on wiki? so just manuals and explanation? what about examples, place for demos of specific usage scenarios, maybe some FAQ etc. Lets ask others for help to define the scope/structure of docs webpage and create separate issues for each part and start only with a basic page
- Second we need to define the tech. I was thinking to use docusaurus as this is something I already use in CLI for Microsoft 365 and it is JS based with react so it is something I am familiarly with and is easy to extend but the biggest disadvantage is that it has biggest carbon footprint https://starlight.astro.build/environmental-impact/ so we should invest in some trees🌳 in exchange 😉. Previously I used MKDocs which is quite simple to use. The biggest problem is that it uses python which I have only basic knowledge off but hey. we may always learn right? Other options we may consider are: VitePress, Docus, Hugo
📷 Images (if possible) with expected result
No response
🤔 Additional remarks or comments
No response