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

docs/core: document core section #13

Merged
merged 10 commits into from
Mar 2, 2024
Merged

docs/core: document core section #13

merged 10 commits into from
Mar 2, 2024

Conversation

l-zeuch
Copy link
Collaborator

@l-zeuch l-zeuch commented Feb 25, 2024

  • docs/main: adjust weight for future chapters
  • docs/main: fix image URLs in markdown documents
  • docs/main: recommend reading the entire docs
  • docs/core: initial work on core documentation
  • docs/core: document control panel access
  • docs/core: document control panel logs
  • doc/core: document command settings page
  • doc/core: squash typos in access settings page

Terms

Adjust the page weight to place nicely with future chapters coming after
in the menu hierarchy, otherwise the order would be weird.

Signed-off-by: Luca Zeuch <[email protected]>
Testing indicated that to properly link to images in markdown documents
intended for content, URLs to that image should start with a leading
"/".

This is especially true for deeply nested pages.

Signed-off-by: Luca Zeuch <[email protected]>
Recommend reading the documentation in its entirety before and/or during
setup, to get things started easier.

Signed-off-by: Luca Zeuch <[email protected]>
Initialise the work on documenting the Core section on the control
panel. This initial page succintly summarises what's going on in this
chapter and lists the subpages via the `children` shortcode.

Signed-off-by: Luca Zeuch <[email protected]>
Document the control panel access settings, going through the individual
knobs to twist from top to bottom as seen on the web.

Signed-off-by: Luca Zeuch <[email protected]>
Document the control panel logs subpage. This page is quite short, as
per the nature of the page itself. There isn't much to say about it, and
its content is self-explanatory nonetheless.

Signed-off-by: Luca Zeuch <[email protected]>
Document the command settings page.

We're detailing the command override priority, how the prefix setting
applies to flags and switches. For available options we first go over
the common options that all three tabs have in common, and then get more
specific via options available in channel overrides as well as those
available in command overrides.

This pretty much concludes the command settings page as well.

Signed-off-by: Luca Zeuch <[email protected]>
Copy link
Contributor

Choose a reason for hiding this comment

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

Line #17 - "login with discord" is on top right.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

hah nice catch 😎

For example, if your prefix is `?`, a command usage with flags and/or switches would look like the following:

```
?wyr -raw
Copy link
Contributor

Choose a reason for hiding this comment

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

consider expanding the "wouldyourather" command instead of the alias

Copy link
Contributor

@savage4618 savage4618 left a comment

Choose a reason for hiding this comment

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

I wrote some notes on things I thought needed noting. Now I realize I probably should have done things differently after hitting the end. hindsight 20/20

@l-zeuch
Copy link
Collaborator Author

l-zeuch commented Feb 27, 2024

Note to self: I should probably reference the labels established under
the image at the start of the page when referring to the individual
settings / sections further down.

@l-zeuch l-zeuch merged commit 24530e7 into master Mar 2, 2024
3 checks passed
@l-zeuch l-zeuch deleted the docs/core-initial-work branch March 2, 2024 15:17
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.

2 participants