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

Documentation improvements #584

Merged

Conversation

MahBoiDeveloper
Copy link
Contributor

PR updates documentation style and makes significant improvement in INISystem.md file.

Changelog:

  • All **Note** replaced to [!NOTE]
  • Same operation has been made with [!WARNING]
  • Added information about data types
  • Added description for parsable ini-keys for classes

Copy link

github-actions bot commented Nov 25, 2024

Nightly build for this pull request:

Docs/INISystem.md Outdated Show resolved Hide resolved
@Metadorius
Copy link
Member

Metadorius commented Nov 25, 2024

Good work but I suggest using the syntax that is used in Phobos and Vinifera, as it is easily copypaste-able into the INIs. You can see the examples in the Phobos or Vinifera docs for new features, I would imagine the docs looking like the following:

#### [XNAControl](link)

- Some text describing what is it
  - Some details

```ini
[SOMECONTROL]  ; XNAControl
X=0            ; integer
Y=0            ; integer
; ...
Enabled=true   ; boolean, whether the control can be interacted with
; ...
```

MahBoiDeveloper and others added 3 commits November 25, 2024 21:26
Co-authored-by: Metadorius <Metadorius@users.noreply.github.com>

Co-authored-by: Kerbiter <crabiter@vivaldi.net>
Co-authored-by: Metadorius <Metadorius@users.noreply.github.com>
@MahBoiDeveloper
Copy link
Contributor Author

Thanks for advise. INISystem.md edited with your recommendations.

Docs/INISystem.md Show resolved Hide resolved
Width=25 ; integer, the Width of the control.
Height=10 ; integer, the Height of the control.
Size=60,30 ; 2 integers, the Width and Height of the control.
Text=Some Text@Example ; text, the text to display for the control (ex: buttons, labels, etc...).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The values should contain default values or no values, if there is no default value. This will ensure that a config maker could copy-paste the reference INI code and have nothing changed in the behavior

Docs/INISystem.md Outdated Show resolved Hide resolved
MahBoiDeveloper and others added 5 commits November 26, 2024 17:41
Co-authored-by: Metadorius <Metadorius@users.noreply.github.com>
Co-authored-by: Kerbiter <crabiter@vivaldi.net>
Co-authored-by: Metadorius <Metadorius@users.noreply.github.com>
Docs/INISystem.md Outdated Show resolved Hide resolved
@Metadorius Metadorius merged commit 432e2d7 into CnCNet:develop Nov 26, 2024
3 checks passed
@MahBoiDeveloper MahBoiDeveloper deleted the Enhancement/DocumentationImprovements branch November 27, 2024 09:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants