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

reference: cleanup syntax-and-data page #64

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

Conversation

l-zeuch
Copy link
Collaborator

@l-zeuch l-zeuch commented Jan 17, 2025

Clean up the Syntax and Data page.

This PR will probably amass a rather large amount of commits, due to its
sheer size. I'll try to keep each individual commit's diff reasonably
small, starting with some cleaning of Gitbook's generated markdown.

To outline some of the changes I'll be making:

  • Some paragraphs are repeated verbatim -- remove / rephrase duplicates.
  • Some sections are far too verbose for an "overview" page -- shorten
    them, and/or move them to learn instead.
  • Certain field descriptions could be more concise; opt for supplemental
    paragraphs below the table instead.
  • Rewrite some data types to be more consistent with the already
    established terms in the learn section. There isn't a lot of reason
    to list the bot's internally used data types.

If you feel like submitting additional patches, please do so (raise them
against this branch). I'd greatly appreciate any work I do not have to
do myself.

Terms

@l-zeuch l-zeuch force-pushed the cleanup/syntax-and-data branch 2 times, most recently from 2ee49cb to 36123cd Compare January 17, 2025 18:17
@l-zeuch l-zeuch force-pushed the cleanup/syntax-and-data branch from 36123cd to 5b62757 Compare January 17, 2025 18:20
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.

1 participant