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

Write a developer's guide #108

Open
ghost opened this issue May 25, 2023 · 0 comments · May be fixed by #109
Open

Write a developer's guide #108

ghost opened this issue May 25, 2023 · 0 comments · May be fixed by #109

Comments

@ghost
Copy link

ghost commented May 25, 2023

The developer's guide should integrate the already existing documentation with:

  • Codebase Overview: Start with a high-level overview of your codebase. Describe the purpose of the library, its main features, and how it is structured at a high level. This includes the main modules, classes, and their relationships.

  • Directory Structure: Provide a clear explanation of the directory structure of your codebase. This should include the purpose of each directory and the type of files that can be found in them.

  • Key Components: Identify the key classes, functions, and modules in your codebase. For each of these, provide a brief description of its purpose, how it works, and how it interacts with other parts of the codebase.

@ghost ghost assigned lbabetto and ghost May 25, 2023
@ghost ghost linked a pull request Jun 5, 2023 that will close this issue
@lbabetto lbabetto removed their assignment Aug 22, 2023
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 a pull request may close this issue.

1 participant