-
Notifications
You must be signed in to change notification settings - Fork 119
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
- Improve the basic docs from the project #322
Draft
Filipe-Souza
wants to merge
14
commits into
MrAntares:master
Choose a base branch
from
Filipe-Souza:improve-basic-doc
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Filipe-Souza
commented
Dec 31, 2023
- This is a proposal of new doc structure. The first setup should be more concise with the project components;
- Also I propose naming the project with components names for better understanding:
- Remote Client API: the one responsible to serve the official game assets
- roBrowser client: the actual client
- Official client: the official game client and resources from Who-Must-Not-Be-Named Corporation
- Updated the getting started guide;
- Moved some information between the files; - Added TODO for some incomplet sections of the docs;
- Fixed links between documents;
- Updated the main README;
This doc is also missing the tools interface and usage, but I didn't use it until now to cover in details how it works. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.