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

More generated documentation pages #20

Open
ghassanpl opened this issue Aug 11, 2023 · 5 comments
Open

More generated documentation pages #20

ghassanpl opened this issue Aug 11, 2023 · 5 comments
Labels
docgen Issues relating to documentation generation good first issue Good for newcomers

Comments

@ghassanpl
Copy link
Owner

Specifically:

  • some sort of home/landing/splash page
  • pages for namespaces
  • generate pages for attributes linked in the documentation
@ghassanpl ghassanpl added good first issue Good for newcomers docgen Issues relating to documentation generation labels Aug 11, 2023
@ghost
Copy link

ghost commented Aug 14, 2023

Hey, I am looking to contribute to writing and structuring documentation. Please message me if you would still like my help.

@ghassanpl
Copy link
Owner Author

Hey, I am looking to contribute to writing and structuring documentation. Please message me if you would still like my help.

@SeanMulligan256 I do! I'm currently in the process of updating the wiki, and would love some help! To be sure, are you looking specifically to document this project (as in, writing github wiki pages and editing README.md), or are you looking into the details of how reflector generates automatic documentation for user projects?

@ghost
Copy link

ghost commented Aug 14, 2023

I am honestly quite new to programming in general only a few years. I want to start contributing to open source and start to understand how to read others' projects and code. I would be up to do some manual work on the documentation in this project specifically. I have never heard of automatic documentation.

@ghassanpl
Copy link
Owner Author

@SeanMulligan256 I appreciate you wanting to help! This is quite a complicated project though, with lots of template trickery, code generation, and with limited use cases, are you sure you're up for the challenge?

@ghost
Copy link

ghost commented Aug 14, 2023

Sounds like quite a lot of work for me who just started, I thought it might have been an easier job. I think I might have to pass on this one, but if there is anything that needs fewer skills I would be open. Thanks for the clarifications.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docgen Issues relating to documentation generation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant