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

api_docs: Add table of links for easy navigation in events api docs. #30105

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Vector73
Copy link
Collaborator

@Vector73 Vector73 commented May 16, 2024

This first commit adds a table of links for easy navigation of events in API documentation.
The second commit converts the event names in API documentation to lowercase.

Screenshot 2024-05-23 135911

Self-review checklist
  • Self-reviewed the changes for clarity and maintainability
    (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

  • Explains differences from previous plans (e.g., issue description).
  • Highlights technical choices and bugs encountered.
  • Calls out remaining decisions and concerns.
  • Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

  • Each commit is a coherent idea.
  • Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

  • Visual appearance of the changes.
  • Responsiveness and internationalization.
  • Strings and tooltips.
  • End-to-end functionality of buttons, interactions and flows.
  • Corner cases, error conditions, and easily imagined bugs.

@Vector73 Vector73 force-pushed the events-table branch 4 times, most recently from 1aa0e44 to b397407 Compare May 18, 2024 03:29
@zulipbot zulipbot added size: L and removed size: M labels May 18, 2024
@Vector73 Vector73 closed this May 18, 2024
@zulipbot zulipbot added size: XS and removed size: L labels May 18, 2024
@Vector73 Vector73 reopened this May 23, 2024
@zulipbot zulipbot added size: L and removed size: XS labels May 23, 2024
@Vector73 Vector73 marked this pull request as ready for review May 23, 2024 08:25
@Vector73 Vector73 changed the title [WIP] Add table of links for easy navigation in events api docs. api_docs: Add table of links for easy navigation in events api docs. May 23, 2024
]
events_table_str.extend(op_list)
events_table_str.append("</div>")
events_table_str.append("</div>")
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

Is it easy to write this using a Jinja2 template (i.e. the things under templates/) instead? Generally our policy is for HTML to be done in templates unless there's a very good reason to do something different.

Copy link
Sponsor Member

Choose a reason for hiding this comment

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

Might be something we should leave to a follow-up, since this file doesn't use those as a general pattern.

.events-table {
column-count: 1;
}
}
Copy link
Sponsor Member

@timabbott timabbott May 23, 2024

Choose a reason for hiding this comment

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

Shouldn't CSS grid be able to just show as many columns as there are space for, without all these media queries?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I tried it but was having trouble getting everything in place. The items were arranged horizontally instead of vertically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants