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/customcommands: document custom commands section #14

Merged
merged 18 commits into from
Mar 25, 2024

Conversation

SoggySaussages
Copy link
Contributor

@SoggySaussages SoggySaussages commented Feb 29, 2024

  • docs/customcommands: add custom-commands chapter
  • docs/customcommands: document commands page

I plan on adding the database page and proofreading everything in full, as well as manually breaking the lines at 120 characters (VSC user :p) but I'd appreciate feedback to know if I'm heading in the right direction.

For your convenience I am hosting this branch on https://yagdocsv2.vedamaharaj.ca/custom-commands.html.

Terms

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: SoggySaussages <[email protected]>
Document the commands page, as well as group behaviours and configuring
groups. Additionally document Custom Commands and configuration thereof.

Signed-off-by: SoggySaussages <[email protected]>
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 have a slight complaint about the images looking like they were grabbed from mobile. The more I think about it though, the more I think it might be fine with the amount of people asking about how to navigate the control panel via mobile.

Copy link
Collaborator

@l-zeuch l-zeuch left a comment

Choose a reason for hiding this comment

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

You have a somewhat inconsistent use of title case in your headers.

I understand that this may cause inconsistencies with the control panel
due to them being labelled in "normal" case, but I think we should stick
to title case as long as said label isn't a full sentence or something
to that extend.

I.e. "Output errors as command response" stays as-is,
but "Saving your command" should be "Saving Your Command" instead.

content/custom-commands/commands.md Show resolved Hide resolved
content/custom-commands/commands.md Outdated Show resolved Hide resolved
content/custom-commands/commands.md Outdated Show resolved Hide resolved
content/custom-commands/commands.md Outdated Show resolved Hide resolved
@l-zeuch
Copy link
Collaborator

l-zeuch commented Mar 3, 2024

General note: As previously discussed in the private #documentation
channel, we now hold images next to the markdown files, rather than
having to mirror our content structure to static/images/.

If you have not done that already, please remember to do so.

add tag to delineate end of text hugo should include in the preview text
in table of contents

Signed-off-by: SoggySaussages <[email protected]>
Move images into same directory as the pages which reference them.

See commit 9a96717

Signed-off-by: SoggySaussages <[email protected]>
Signed-off-by: SoggySaussages <[email protected]>
Document the database page with details of each column.

Signed-off-by: SoggySaussages <[email protected]>
Add screenshots for this tooltip which is otherwise confusing. I think
it either needs these screenshots or to be removed entirely.

Signed-off-by: SoggySaussages <[email protected]>
Signed-off-by: SoggySaussages <[email protected]>
@SoggySaussages SoggySaussages marked this pull request as ready for review March 24, 2024 01:11
@SoggySaussages SoggySaussages requested a review from l-zeuch March 24, 2024 01:12
@l-zeuch l-zeuch self-assigned this Mar 24, 2024
.vscode/settings.json Outdated Show resolved Hide resolved
content/custom-commands/_index.md Outdated Show resolved Hide resolved
content/custom-commands/commands.md Outdated Show resolved Hide resolved
content/custom-commands/commands.md Outdated Show resolved Hide resolved
content/custom-commands/commands.md Outdated Show resolved Hide resolved
content/custom-commands/commands.md Outdated Show resolved Hide resolved
content/custom-commands/commands.md Outdated Show resolved Hide resolved
content/custom-commands/database.md Outdated Show resolved Hide resolved
content/custom-commands/database.md Outdated Show resolved Hide resolved
SoggySaussages and others added 5 commits March 24, 2024 13:40
Signed-off-by: SoggySaussages <[email protected]>
Signed-off-by: SoggySaussages <[email protected]>
Signed-off-by: SoggySaussages <[email protected]>
also shift "This feature is premium only" to the top of feature's
description.

Signed-off-by: SoggySaussages <[email protected]>
* seach -> search
* 100kB -> 100 kB

Signed-off-by: Luca Zeuch <[email protected]>
@l-zeuch l-zeuch merged commit 6ffee11 into botlabs-gg:master Mar 25, 2024
2 checks passed
@l-zeuch
Copy link
Collaborator

l-zeuch commented Mar 25, 2024

I've gone ahead fixed the last two review comments myself.

Thanks for the PR!

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