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

Restructure Readme to more of a tree like approach #734

Open
munapower opened this issue Oct 16, 2023 · 7 comments
Open

Restructure Readme to more of a tree like approach #734

munapower opened this issue Oct 16, 2023 · 7 comments
Assignees
Labels
documentation This contains documentation/description/comments feature

Comments

@munapower
Copy link
Contributor

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

@mbrandenburger
Copy link
Contributor

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 mbrandenburger added the documentation This contains documentation/description/comments label Oct 19, 2023
@anshikavashistha
Copy link

May I work on this issue?
@mbrandenburger @munapower

@mbrandenburger
Copy link
Contributor

Hi @anshikavashistha, yes please give it a try.

@anshikavashistha
Copy link

@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
Copy link

@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.

@mbrandenburger
Copy link
Contributor

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

@munapower
Copy link
Contributor Author

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This contains documentation/description/comments feature
Projects
None yet
Development

No branches or pull requests

3 participants