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

💡 [Feature]: Create docs web page for this product #352

Open
Adam-it opened this issue Nov 19, 2024 · 2 comments
Open

💡 [Feature]: Create docs web page for this product #352

Adam-it opened this issue Nov 19, 2024 · 2 comments
Assignees
Labels
🗒️ documentation Improvements or additions to documentation ⭐ enhancement New feature or request 💬 needs discussion 🤔 research needs researching before I start hacking
Milestone

Comments

@Adam-it
Copy link
Member

Adam-it commented Nov 19, 2024

🎯 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:

  1. 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
  2. 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

@Adam-it Adam-it added 🗒️ documentation Improvements or additions to documentation ⭐ enhancement New feature or request 💬 needs discussion 🤔 research needs researching before I start hacking labels Nov 19, 2024
@Adam-it Adam-it self-assigned this Nov 19, 2024
@Adam-it Adam-it added this to the v5.0 milestone Nov 25, 2024
@Sandeep-FED
Copy link

@Adam-it I’ll do this, will share my ideas shortly 😇

@Adam-it
Copy link
Member Author

Adam-it commented Nov 25, 2024

@Sandeep-FED This issue is not ready to be taken.
I may only assign you to issues with label 🙏 help wanted.
This is still under prep work so I still need to think how I would like to go about it. But here I am open for discussion and suggestions (so needs discussion label) that is why it would be really awesome if you could brainstorm with me what is the best way to go about this issue, what are the ideas for doc pages, what would you like to have on such a doc page for SPFx toolkit which would be helpful for others 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🗒️ documentation Improvements or additions to documentation ⭐ enhancement New feature or request 💬 needs discussion 🤔 research needs researching before I start hacking
Projects
None yet
Development

No branches or pull requests

2 participants