Skip to content

docs: split command reference into focused guides#681

Open
Sukuna0007Abhi wants to merge 2 commits intohyperledger-labs:mainfrom
Sukuna0007Abhi:docs/upstream-667-command-guides
Open

docs: split command reference into focused guides#681
Sukuna0007Abhi wants to merge 2 commits intohyperledger-labs:mainfrom
Sukuna0007Abhi:docs/upstream-667-command-guides

Conversation

@Sukuna0007Abhi
Copy link
Copy Markdown

@Sukuna0007Abhi Sukuna0007Abhi commented Apr 2, 2026

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

Signed-off-by: Sukuna0007Abhi <appsonly310@gmail.com>
@Sukuna0007Abhi
Copy link
Copy Markdown
Author

Pls review @dzikowski @OsamaRab3

Copy link
Copy Markdown
Contributor

@OsamaRab3 OsamaRab3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.json would 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.

@Sukuna0007Abhi
Copy link
Copy Markdown
Author

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.json would 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>
@Sukuna0007Abhi Sukuna0007Abhi requested a review from OsamaRab3 April 6, 2026 19:11
@Sukuna0007Abhi
Copy link
Copy Markdown
Author

Could you pls review @OsamaRab3, also should I include the screenshot I taken ? Or is it fine

@dzikowski
Copy link
Copy Markdown
Contributor

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Restructure and Improve Fablo Documentation with Detailed Command Guides

3 participants