Skip to content

reference,learn: start moving custom interactions to learn #73

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

l-zeuch
Copy link
Collaborator

@l-zeuch l-zeuch commented Apr 6, 2025

This PR aims to move the Custom Interactions page--currently residing
inside docs/reference--to a new Advanced section in the learning course.

The short-term goal is to split the incredibly detailed page (thanks to
the amazing work of @SoggySaussages) into smaller, more digestible
sections. I oriented these splits around the already existing sections
on the mentioned page.

The long-term goal is to make space under the (debatably) filled
Reference in the main docs section, and also spark inspiration for more
advanced topics in the learning course.

Signed-off-by: Luca Zeuch [email protected]

Terms


I am further inviting @SoggySaussages to carefully examine my changes
with the highest scrutiny, as I am not sure if I have done the original
work justice. I am also open to any suggestions for improvement.

@l-zeuch
Copy link
Collaborator Author

l-zeuch commented Apr 6, 2025

This first commit serves to outline my intentions with splitting up the
page.

The general idea in "Creating Interactive Elements" is to first introduce
the elements one can create in custom commands, then explain how to make
them useful--therefore I chose to elide mentions of custom_id, but
still kept those in when defining the elements, such that we can more
easily back-reference them when it comes to writing this section.

Perhaps instead of splitting "Parsing an Interaction" into a new page,
as the current headers would suggest it (going by my current logic), we
can merge it with the current WIP page? Though, I'm unsure how to
appropriately name it, then. Suggestions welcome.

@l-zeuch l-zeuch force-pushed the advanced-learn-v1 branch from f743168 to 898f156 Compare April 6, 2025 16:23
@l-zeuch l-zeuch force-pushed the advanced-learn-v1 branch from 898f156 to c58df24 Compare May 21, 2025 11:07
@l-zeuch l-zeuch force-pushed the advanced-learn-v1 branch from c58df24 to 7916299 Compare June 2, 2025 15:06
@l-zeuch
Copy link
Collaborator Author

l-zeuch commented Jun 2, 2025

Unless I missed anything, the move should now be complete--I hope I
split the original page up reasonably well into the proposed
sub-chapters.

@SoggySaussages - would you mind giving this a review, just to make sure
it's all still there?

@l-zeuch l-zeuch marked this pull request as ready for review June 2, 2025 15:08
@l-zeuch
Copy link
Collaborator Author

l-zeuch commented Jun 2, 2025

As an afterthought, we should also consider shortening the reference
page to the bare minimum; I don't think outright removing it is a good
idea, especially with all the linking to it on the support server. I
also haven't checked any crosslinks in the docs themselves, yet, as well
as indicating that this guide has been moved.

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.

am I doing this right?

@l-zeuch l-zeuch force-pushed the advanced-learn-v1 branch from e1d335d to 18a40d4 Compare June 16, 2025 08:34
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