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

High level description of stacker.news codebase #1089

Open
SouthKoreaLN opened this issue Apr 18, 2024 · 0 comments
Open

High level description of stacker.news codebase #1089

SouthKoreaLN opened this issue Apr 18, 2024 · 0 comments
Labels
difficulty:easy documentation improvements or additions to documentation feature new product features that weren't there before local dev

Comments

@SouthKoreaLN
Copy link
Contributor

SouthKoreaLN commented Apr 18, 2024

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

Just wondering if some other new contributors to Stacker.news would like to have a high-level introduction of how everything fits together in the stacker.news codebase. I am truly new to all of this, not just stacker.news, so it could be that this would not benefit anyone else but me. In such case, it is of course not worth the trouble to draft something. And I am for sure just learning by doing, constantly grepping to find the places where things are defined and implemented, called and stored, etc.

Describe the solution you'd like

Add an md file in the docs folder that describes the structure, the high-level logic linking the different parts, the philosophy behind certain choices (stateless, etc), some preferred practices, etc.
This could then be loaded of course in the FOSS homepage (see #1058).

Describe alternatives you've considered

The alternative is nearly as good, i.e. just learning by doing.

Additional context

Please don't waste time on this if I am the only one that would benefit from this.

@SouthKoreaLN SouthKoreaLN added the feature new product features that weren't there before label Apr 18, 2024
@huumn huumn added documentation improvements or additions to documentation local dev difficulty:easy labels Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty:easy documentation improvements or additions to documentation feature new product features that weren't there before local dev
Projects
None yet
Development

No branches or pull requests

2 participants