fabric-private-chaincode icon indicating copy to clipboard operation
fabric-private-chaincode copied to clipboard

Published 20 hours ago • verified publisher icon hyperledger

Restructure Readme to more of a tree like approach

Open munapower opened this issue 1 year ago • 7 comments

Is your feature request related to a problem? Please describe.

Currently the beginner is prompted with all the information all at once and this could lead to confusion. A user-friendly approach could be to add the required information in each readme in each branch. Describe the solution you'd like

Subdividing the readme into sections that are mentioned in the main but are documented in the branch that they are linked to. Describe alternatives you've considered

Additional context

munapower avatar Oct 16 '23 17:10 munapower

I suggest that we clean up the main README.md and create topic specific files in the docs folder.

The main readme should aim to clearly communicate what this project is about and how people can quickly start playing with it.

Some suggestions:

  • Main README.md should keep the getting started section including setup Option 1). Here we just link to Option 2) in the docs/.
  • Revisit the intro section and link to Architecture and Components in docs/.
  • Dedicated trouble shooting file in docs/.
  • Move SGX Support to docs/.
  • Move reference guides to docs/.
  • References can be moved to docs/ and extended with other existing material.

mbrandenburger avatar Oct 16 '23 21:10 mbrandenburger

May I work on this issue? @mbrandenburger @munapower

anshikavashistha avatar May 04 '24 11:05 anshikavashistha

Hi @anshikavashistha, yes please give it a try.

mbrandenburger avatar May 06 '24 09:05 mbrandenburger

@mbrandenburger Agreed with you. We should only mention some introductory part in the README.md and rest of the content should be moved to docs folder as you have mentioned.

I suggest that we clean up the main README.md and create topic specific files in the docs folder.

The main readme should aim to clearly communicate what this project is about and how people can quickly start playing with it.

Some suggestions:

  • Main README.md should keep the getting started section including setup Option 1). Here we just link to Option 2) in the docs/.
  • Revisit the intro section and link to Architecture and Components in docs/.
  • Dedicated trouble shooting file in docs/.
  • Move SGX Support to docs/.
  • Move reference guides to docs/.
  • References can be moved to docs/ and extended with other existing material.

anshikavashistha avatar May 06 '24 12:05 anshikavashistha

@mbrandenburger We could create dedicated Files in docs Folder:

  1. troubleshooting.md: Provide solutions to common issues.
  2. sgx_support.md: Explain SGX Support details.
  3. Move reference guides like api_reference.md and cli_reference.md to docs.
  4. references.md: Expand existing references with additional resources.

anshikavashistha avatar May 06 '24 12:05 anshikavashistha

@munapower could you please guide @anshikavashistha with this issue. thanks

mbrandenburger avatar May 13 '24 18:05 mbrandenburger

@anshikavashistha could you add here an outline of what we currently have in the readme?

Something like: Hyperledger Fabric Private Chaincode

  1. Architecture and components 1 .1. Overview 1.2. Design 1.3. Source Organization
  2. Releases
  3. Getting Started 3.1. Clone Fabric Private Chaincode
  4. Setup your development environment .... So that way we can see all the topics and decide if and how to reorg them. Thanks!

munapower avatar May 13 '24 22:05 munapower