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

Update Dapp README and Create Directory-Specific READMEs #85

Closed
2 of 3 tasks
Taombawkry opened this issue Apr 1, 2024 · 0 comments
Closed
2 of 3 tasks

Update Dapp README and Create Directory-Specific READMEs #85

Taombawkry opened this issue Apr 1, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Taombawkry
Copy link
Contributor

Documentation Category

  • Main README Level
  • Specific Directory README
  • Blog/External Documentation

Describe the Documentation Need
The SummitShare Dapp's frontend has been restructured, introducing four main directories (dashboard, help, auth, main) that encapsulate different facets of the application. The main README needs to be updated to reflect these changes, providing a brief overview of each new directory and its role in the platform. Additionally, directory-specific READMEs are required at the root of each new directory to detail the contained components, their functionalities, and the technology stack utilized.

Target Audience
The primary audience for this documentation includes new contributors, current developers, and project administrators looking to understand the latest project structure and contribute effectively.

Key Points to Cover

  1. Main README Update:

    • Introduction to the new structure.
    • Brief descriptions of each new directory (dashboard, help, auth, main), including their purpose and the part of the platform they correspond to.
  2. Directory-Specific READMEs:

    • For each directory (dashboard, help, auth, main):
      • Overview of the directory's purpose.
      • Breakdown of components within the directory.
      • Description of the technology stack used.
      • Explanation of how the directory integrates with the rest of the application.

References or Examples

  • Reference the current Dapp README for formatting and style.
  • Look at other open-source projects for best practices on structuring directory-specific READMEs.

Additional context
The restructuring of the Dapp frontend aims to enhance modularity, maintainability, and ease of navigation for developers. The updated documentation should reflect these goals and provide clear guidance for contributors.

@Taombawkry Taombawkry added the documentation Improvements or additions to documentation label Apr 1, 2024
@Taombawkry Taombawkry moved this to In Progress in SS To-do Tracker Apr 1, 2024
@Taombawkry Taombawkry closed this as not planned Won't fix, can't repro, duplicate, stale Oct 11, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in SS To-do Tracker Oct 11, 2024
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
Projects
None yet
Development

No branches or pull requests

2 participants