Skip to content

Commit

Permalink
Adjust development section folder structure (#235)
Browse files Browse the repository at this point in the history
* Adjust development section folder structure

The structure of development related pages is a leftover from when
modding and development were combined in a single folder.

Modding related content has since long moved to ModdingDocs.

As such we should update the folder structure accordingly

* Update broken links
  • Loading branch information
GeckoEidechse authored Oct 11, 2023
1 parent 97665ea commit 23849da
Show file tree
Hide file tree
Showing 13 changed files with 19 additions and 19 deletions.
22 changes: 11 additions & 11 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,17 @@
## Modding and Development

* [Modding](modding/README.md)
* [Development](modding-and-development/development/README.md)
* [Repositories](modding-and-development/development/repositories/README.md)
* [Atlas](modding-and-development/development/repositories/atlas.md)
* [NorthstarMods](modding-and-development/development/repositories/northstarmods.md)
* [NorthstarLauncher](modding-and-development/development/northstarlauncher.md)
* [NorthstarMasterServer (old)](modding-and-development/development/northstarmasterserver/README.md)
* [Deploy](modding-and-development/development/northstarmasterserver/deploy.md)
* [Contributing code to Northstar](modding-and-development/development/contributing-code-to-northstar.md)
* [Testing](modding-and-development/testing.md)
* [Reviewing](modding-and-development/development/reviewing.md)
* [Releases](modding-and-development/development/releases.md)
* [Development](development/README.md)
* [Repositories](development/repositories/README.md)
* [Atlas](development/repositories/atlas.md)
* [NorthstarMods](development/repositories/northstarmods.md)
* [NorthstarLauncher](development/northstarlauncher.md)
* [NorthstarMasterServer (old)](development/northstarmasterserver/README.md)
* [Deploy](development/northstarmasterserver/deploy.md)
* [Contributing code to Northstar](development/contributing-code-to-northstar.md)
* [Testing](development/testing.md)
* [Reviewing](development/reviewing.md)
* [Releases](development/releases.md)

## Other

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Read [CONTRIBUTING.md](https://github.com/R2Northstar/Northstar/blob/main/CONTRI
Please remember that issues created in the Northstar repositories should be related to the mod, avoid creating issues asking for tech support or problems unrelated to the project.
{% endhint %}

Check the [Development](modding-and-development/development/README.md) section if you are unsure of where to open a ticket.
Check the [Development](development/README.md) section if you are unsure of where to open a ticket.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The old NodeJS master server has been replaced in favour of the Go rewrite calle

The master server is responsible for centralizing game servers created by players, it also verifies that connecting players own an Origin account with Titanfall 2.

There's no need to host your own master server to play games with other people, you can use [direct connect](../../../using-northstar/direct-connect.md) or just setup a [normal server](../../../hosting-a-server-with-northstar/basic-listen-server.md) that announces itself to `northstar.tf`. This tutorial is aimed for those who want to contribute improvements to the code or test their own changes to the project.
There's no need to host your own master server to play games with other people, you can use [direct connect](../../using-northstar/direct-connect.md) or just setup a [normal server](../../hosting-a-server-with-northstar/basic-listen-server.md) that announces itself to `northstar.tf`. This tutorial is aimed for those who want to contribute improvements to the code or test their own changes to the project.

## Contents

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ It's not necessary to do both when reviewing as long as you mention what you did

For code review head to the _"Files changed"_ section of the PR.

![](../../.gitbook/assets/review1.png)
![](../.gitbook/assets/review1.png)

From there you can select the line(s) you want to leave a comment on.

![](../../.gitbook/assets/review2.PNG)
![](../.gitbook/assets/review2.PNG)

Type in your comment and click on _"Start a review"_.

![](../../.gitbook/assets/review3.png)
![](../.gitbook/assets/review3.png)

Note that this will **NOT** post your comment immediately! Add any remaining comments to other lines of code, then head to the _Finishing up_ section of this wiki page to see how to post your code review.

Expand All @@ -38,7 +38,7 @@ Note that this will **NOT** post your comment immediately! Add any remaining com
For testing a PR, refer to the following page

{% content-ref url="../testing.md" %}
[testing.md](../testing.md)
[testing.md](./testing.md)
{% endcontent-ref %}

The TL;DR is to test the aspect that has been changed.
Expand All @@ -47,7 +47,7 @@ The TL;DR is to test the aspect that has been changed.

After you performed the testing and/or code review leave a final comment by clicking on _"Finish your review"_ on the top right of the _"Files changed"_ page of the PR.

![](../../.gitbook/assets/review4.png)
![](../.gitbook/assets/review4.png)

In your final comment make sure to mention what you did, e.g. which aspects of the change you tested for or what you considered during code review (formatting, edge cases, ...). The more detailed this part is the easier it is for other reviewers to tell which aspects they can skip during reviewing to speed up the process.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Before starting, make sure you have a **working and up-to-date Northstar install
 ![rcon4](https://user-images.githubusercontent.com/40122905/179727511-877641f8-e5fc-4a34-bcf1-29bafefc1ad2.png)
5. Once downloaded, open the zip and copy `Northstar.dll` and `NorthstarLauncher.exe` to your Titanfall2 folder, overwriting the existing DLL and EXE in there.

Alternatively, compiling the PR'd code from source is also an option. For this, refer to [northstarlauncher.md](development/northstarlauncher.md "mention")
Alternatively, compiling the PR'd code from source is also an option. For this, refer to [northstarlauncher.md](northstarlauncher.md "mention")

#### NorthstarMods

Expand Down

0 comments on commit 23849da

Please sign in to comment.