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: added introduction to docs site #149

Merged
merged 2 commits into from
Mar 11, 2023

Conversation

JoshuaKGoldberg
Copy link
Owner

PR Checklist

Overview

Adds a few explanatory lines and a canonical function example to the docs.

Screenshot of the attached Markdown updates, rendered in the TypeDoc index page

@codecov
Copy link

codecov bot commented Mar 8, 2023

Codecov Report

Merging #149 (e0dda82) into main (e9bc48b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #149   +/-   ##
=======================================
  Coverage   21.80%   21.80%           
=======================================
  Files          18       18           
  Lines         431      431           
  Branches      171      171           
=======================================
  Hits           94       94           
  Misses        315      315           
  Partials       22       22           
Flag Coverage Δ
4.2.4 21.11% <ø> (ø)
4.3.5 21.34% <ø> (ø)
4.4.4 21.34% <ø> (ø)
latest 21.34% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@RebeccaStevens
Copy link
Collaborator

Looks good to me.
Though maybe we should add a note about if a function appears to be missing, users should check if it exists on typescript itself.

@JoshuaKGoldberg JoshuaKGoldberg merged commit 13c5a2c into main Mar 11, 2023
@JoshuaKGoldberg JoshuaKGoldberg deleted the typedoc-index-explanation branch March 11, 2023 22:14
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.

📝 Documentation: Add introduction paragraph(s) to docs site
2 participants