Skip to content

Commit

Permalink
docs: Reference dev docs better
Browse files Browse the repository at this point in the history
  • Loading branch information
3urobeat committed Jan 18, 2025
1 parent a98647d commit 0585ecc
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<p align="center">
<a href="#introduction">Introduction</a> •
<a href="#setup-config-guide">Setup & Configuration Guide</a> •
<a href="#the-wiki">Wiki</a> •
<a href="#the-wiki">Wiki/Docs</a> •
<a href="#questions-bugs-issues--betas">Get Help</a> •
<a href="#license">License</a>
</p>
Expand Down Expand Up @@ -71,6 +71,9 @@ This process is pretty simple and should not take you long!
The Wiki of this repository holds a lot of valuable information, please [check it out](./docs/wiki#readme)!
You'll find pages on how to add proxies to drastically increase the amount of possible comments, how to integrate the bot into your own application, adding your own language, documentation on errors, the config, advancedconfig and much more.

Besides the user documentation (wiki), the docs directory also holds the developer documentation.
If you want to learn more about the inner workings or are planning on contributing, please [check it out](./docs/dev#readme)!

#### **Questions, Bugs, Issues & Betas**
If you have any questions, please feel free to open a [Q&A discussion](https://github.com/3urobeat/steam-comment-service-bot/discussions/new?category=q-a)!
If you encountered a bug or wish a feature to be added, please open an [issue](https://github.com/3urobeat/steam-comment-service-bot/issues/new/choose)!
Expand Down
6 changes: 6 additions & 0 deletions docs/dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Are you rather searching for the wiki? [Click here to get redirected](../wiki#re
This documentation uses the same structure as the `src` folder. Each top-level module listed here contains further links to its submodules.
The order of this list represents the order in which they are instantiated when the application is started.

**Module Tree:**
- [Introduction](./introduction.md)
- Parent Process:
- [Starter](./starter.md)
Expand All @@ -29,6 +30,11 @@ The order of this list represents the order in which they are instantiated when

&nbsp;

Every page consists of an introduction, optionally helpers & events and the automatically generated JsDocs from the code base for that module.
Use the JsDocs section to find explanations and signatures for functions and properties which that module exposes.

&nbsp;

## Contact
Steam profile: https://steamcommunity.com/id/3urobeat
Steam group: https://steamcommunity.com/groups/3urobeatGroup
Expand Down
10 changes: 10 additions & 0 deletions docs/wiki/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Please read this page *before* diving in, it contains a few **very** important p

## Table Of Contents
- [Reporting an issue](#reporting-an-issue)
- [Developer Documentation](#dev-docs)
- [How to fork and open pull requests](#how-to-fork-and-open-pull-requests)
- [Updating or Adding a language translation](#translating)
- [Styling guidelines](#styling-guidelines)
Expand All @@ -30,6 +31,15 @@ If you have any questions, please open a [Q&A discussion](https://github.com/3ur

&nbsp;

<a id="dev-docs"></a>

## Developer Documentation
You might already be familiar with the user documentation/wiki (this directory).
The docs directory however also holds the developer documentation, which contains more detailed information, including the generated JsDocs for every module.
Please check it out and use it as a reference while working on the project. [Link](../dev#readme)

&nbsp;

## How to fork and open pull requests
To contribute code to the project, you first need to fork this repository. Go to the main page of this repository and click on the "Fork" button in the top right.
Before clicking the "Create fork" button in the next menu, make sure the checkmark at "Copy the `master` branch only" is **unchecked**!
Expand Down
2 changes: 1 addition & 1 deletion src/data/fileStructure.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
{
"path": "README.md",
"url": "https://raw.githubusercontent.com/3urobeat/steam-comment-service-bot/beta-testing/README.md",
"checksum": "9aae26d99d45afd93be0075368826e51"
"checksum": "729fd6a72f5cdf67f21f4a68c4404fb2"
},
{
"path": "eslint.config.mjs",
Expand Down

0 comments on commit 0585ecc

Please sign in to comment.