docs: split command reference into focused guides#681
docs: split command reference into focused guides#681Sukuna0007Abhi wants to merge 2 commits intohyperledger-labs:mainfrom
Conversation
Signed-off-by: Sukuna0007Abhi <appsonly310@gmail.com>
|
Pls review @dzikowski @OsamaRab3 |
OsamaRab3
left a comment
There was a problem hiding this comment.
I think it doesn’t fully address the goal of the issue yet. The proposal was to provide more detailed and beginner friendly documentation, not just a shorter version.
Here are a few suggestions to improve it:
- The description is a bit too brief. It would be helpful to explain what exactly is generated.
- The “Expected output” section is quite high level. Adding a real snippet of the generated
fablo-config.jsonwould make it much more useful. - It would be great to include a sample terminal output (what the user actually sees after running the command).
- Consider adding more concrete real world use cases instead of generic ones.
- A configuration example would also help users understand what gets created and how they can modify it.
Overall, this is a great start, but adding more practical details and examples would make the documentation much more helpful for new users.
Thanks for the suggestions, I will surely improve it and re-request a review |
Signed-off-by: Sukuna0007Abhi <appsonly310@gmail.com>
|
Could you pls review @OsamaRab3, also should I include the screenshot I taken ? Or is it fine |
|
currently fablo documentation consists of a single thin file that covers most of the features. It's easier to scan and search that separated files for commands. Could you elaborate why Fablo would benefit with the new approach? |
This PR moves command references from a long README section into focused guides under README.md, and updates README.md to link to them.
Fixes #667