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: "Frequently Asked Questions" page #4722

Merged
merged 4 commits into from
May 15, 2024
Merged

docs: "Frequently Asked Questions" page #4722

merged 4 commits into from
May 15, 2024

Conversation

iuioiua
Copy link
Collaborator

@iuioiua iuioiua commented May 14, 2024

First pass. Other questions that should be answered:

  1. Why is the Standard Library versioned differently to the Deno runtime?
  2. What are the compatibility guarantees for the Standard Library?

@kt3k, are you able to handle these?

@iuioiua iuioiua requested a review from kt3k as a code owner May 14, 2024 04:02
Copy link

codecov bot commented May 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.44%. Comparing base (4398642) to head (7670951).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4722   +/-   ##
=======================================
  Coverage   91.44%   91.44%           
=======================================
  Files         480      480           
  Lines       37318    37318           
  Branches     5316     5316           
=======================================
  Hits        34126    34126           
  Misses       3136     3136           
  Partials       56       56           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

.github/FAQ.md Outdated
follows:

```ts, ignore
import { bar } from "jsr:@std/foo@1/bar";
Copy link
Member

Choose a reason for hiding this comment

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

deno add <pkg> adds import map entry with the form of "@std/foo": "jsr:@std/foo@^1.2.3". The above example seems slightly inconsistent with it to me

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sorry, what are you suggesting? I changed it to jsr:@std/foo@^1. How's that?

.github/FAQ.md Outdated Show resolved Hide resolved
@kt3k
Copy link
Member

kt3k commented May 14, 2024

.github/FAQ.md

I wonder this is a right place to document this information. How about adding these sections in "Standard Library" page of deno-docs https://docs.deno.com/runtime/manual/basics/standard_library ?

@iuioiua
Copy link
Collaborator Author

iuioiua commented May 14, 2024

.github/FAQ.md

I wonder this is a right place to document this information. How about adding these sections in "Standard Library" page of deno-docs https://docs.deno.com/runtime/manual/basics/standard_library ?

Almost all information on the Standard Library should be contained within this repo. It doesn't sense to disperse this information elsewhere.

@iuioiua iuioiua requested a review from kt3k May 14, 2024 22:30
@kt3k
Copy link
Member

kt3k commented May 15, 2024

Almost all information on the Standard Library should be contained within this repo. It doesn't sense to disperse this information elsewhere.

Maybe this topic is out of scope of this PR, but the issue with .github/FAQ.md is that this file doesn't appear anywhere in jsr.io. I think there's high chance that users miss this file.

Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

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

LGTM

@iuioiua iuioiua merged commit 99bbda2 into main May 15, 2024
12 checks passed
@iuioiua iuioiua deleted the faq branch May 15, 2024 03:35
@iuioiua
Copy link
Collaborator Author

iuioiua commented May 15, 2024

Almost all information on the Standard Library should be contained within this repo. It doesn't sense to disperse this information elsewhere.

Maybe this topic is out of scope of this PR, but the issue with .github/FAQ.md is that this file doesn't appear anywhere in jsr.io. I think there's high chance that users miss this file.

Hopfully, jsr-io/jsr#507 fixes that. I would be happy to discuss it elsewhere.

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.

None yet

2 participants