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

Inline API reference #532

Merged
merged 162 commits into from
Mar 17, 2024
Merged

Inline API reference #532

merged 162 commits into from
Mar 17, 2024

Conversation

KnorpelSenf
Copy link
Member

@KnorpelSenf KnorpelSenf commented Oct 25, 2022

Work in progress.

Pending tasks:

  • replace links to inlined API reference
  • create TOC for each path, such as /api/core
  • complete info for classes
    • include all class members
    • include links to source definitions
  • add pages for all other types of exports (see commented out parts)
  • decide how to handle clashes
  • support /types.ts
  • run deno fmt in order to make the doc styles more consistent (blocked by deno fmt strips whitespace from multiline strings inside link texts with "proseWrap": "preserve" denoland/deno#16730)
  • fix GH links
  • fix loads of details in the docs, such as link highlighting, cross-references between API objects, and likely a lot more
  • Support @inheritdoc
  • Replace links in other pages.
  • Tell the reader what the API reference is.
  • function overloads such as for webhookCallback are broken
  • method overloads such as for Composer#filter are ugly
  • properties defined via constructor parameters such as for Bot are not listed as properties
  • properties defined via constructor parameters such as for Bot should get docs from the @param tags in the JSDoc comment of the constructor
  • private properties are listed as public
  • links from the JSDoc to the website need to be rewritten so that they do not open as external links
  • something is very broken with InputMedia in types
  • cross-package references such as RawApi in files/hydrateFiles currently 404
  • Following direct links like this one will break the page layout upon navigation

@KnorpelSenf KnorpelSenf added help wanted Extra attention is needed not translatable Translator intervention is not required. chore Modifies or is related to tooling, configuration, or setup. labels Oct 25, 2022
@github-actions
Copy link

github-actions bot commented Oct 25, 2022

🚀 Deployed on https://65f76187c26572cafaaa2235--grammy.netlify.app

@github-actions github-actions bot temporarily deployed to pull request October 25, 2022 21:33 Inactive
@KnorpelSenf
Copy link
Member Author

@github-actions github-actions bot temporarily deployed to pull request October 25, 2022 21:38 Inactive
@github-actions github-actions bot temporarily deployed to pull request October 25, 2022 21:40 Inactive
@github-actions github-actions bot temporarily deployed to pull request November 14, 2022 23:12 Inactive
@github-actions github-actions bot temporarily deployed to pull request November 14, 2022 23:17 Inactive
@KnorpelSenf
Copy link
Member Author

@github-actions github-actions bot temporarily deployed to pull request November 20, 2022 21:30 Inactive
@github-actions github-actions bot temporarily deployed to pull request November 20, 2022 21:30 Inactive
@github-actions github-actions bot temporarily deployed to pull request November 20, 2022 21:30 Inactive
@github-actions github-actions bot temporarily deployed to pull request November 20, 2022 21:30 Inactive
@github-actions github-actions bot temporarily deployed to pull request November 20, 2022 21:30 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2024 20:24 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2024 20:28 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2024 20:32 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2024 20:36 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2024 20:46 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2024 21:06 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2024 21:12 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2024 21:21 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2024 21:34 Inactive
@KnorpelSenf
Copy link
Member Author

LGTM

@rojvv rojvv added this pull request to the merge queue Mar 17, 2024
Merged via the queue into main with commit 9c8cd10 Mar 17, 2024
6 checks passed
@rojvv rojvv deleted the inline-api-ref branch March 17, 2024 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat not translatable Translator intervention is not required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants