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

Reorganize JS numbers/dates/strings guides #37563

Merged
merged 2 commits into from
Jan 14, 2025
Merged

Conversation

Josh-Cena
Copy link
Member

In tandem with #37344, we need to write a usage guide for Temporal. The current organization of the guides are a bit awkward and squeezing Temporal into "Numbers and dates" would make that page a bit too cramped and lose focus. As such, I think it's time to reorganize the topics a bit. Previously, we have "Numbers and dates" (which talks about Number, BigInt, Math, and Date) and "Text formatting" (which talks about String and Intl). Now, we are reorganizing them as:

  • Numbers and strings: Number, BigInt, Math, String
  • Representing dates & times: Date, and in the future Temporal
  • Internationalization: Intl

In the future, the latter two pages will be greatly expanded to talk about all modern APIs. This PR refrains from introducing major content to make it easier to review and merge, but that does leave the latter two pages as looking a bit "thin".

@Josh-Cena Josh-Cena requested review from a team as code owners January 8, 2025 23:51
@Josh-Cena Josh-Cena requested review from chrisdavidmills and removed request for a team January 8, 2025 23:51
@github-actions github-actions bot added Content:HTML Hypertext Markup Language docs Content:JS JavaScript docs size/l [PR only] 501-1000 LoC changed labels Jan 8, 2025
Copy link
Contributor

github-actions bot commented Jan 8, 2025

Preview URLs (15 pages)
Flaws (355)

Note! 3 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/HTML/Date_and_time_formats
Title: Date and time formats used in HTML
Flaw count: 23

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/HTML
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/HTML_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/HTML/Introduction_to_HTML
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/HTML/Introduction_to_HTML/Getting_started
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/HTML/Introduction_to_HTML/The_head_metadata_in_HTML
    • and 18 more flaws omitted

URL: /en-US/docs/Web/JavaScript/Reference/Template_literals
Title: Template literals (Template strings)
Flaw count: 8

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
    • and 3 more flaws omitted

URL: /en-US/docs/Web/JavaScript/Guide
Title: JavaScript Guide
Flaw count: 8

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
    • and 3 more flaws omitted

URL: /en-US/docs/Web/JavaScript/Guide/Using_classes
Title: Using classes
Flaw count: 8

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
    • and 3 more flaws omitted

URL: /en-US/docs/Web/JavaScript/Guide/Internationalization
Title: Internationalization
Flaw count: 8

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
    • and 3 more flaws omitted

URL: /en-US/docs/Web/JavaScript/Guide/Representing_dates_times
Title: Representing dates & times
Flaw count: 8

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
    • and 3 more flaws omitted

URL: /en-US/docs/Web/JavaScript/Guide/Expressions_and_operators
Title: Expressions and operators
Flaw count: 8

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
    • and 3 more flaws omitted

URL: /en-US/docs/Web/JavaScript/Guide/Numbers_and_strings
Title: Numbers and strings
Flaw count: 9

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
    • and 3 more flaws omitted
  • broken_links:
    • Can't resolve /en-US/docs/Web/JavaScript/Guide/Regular_Expressions

URL: /en-US/docs/Web/JavaScript/Guide/Iterators_and_generators
Title: Iterators and generators
Flaw count: 8

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
    • and 3 more flaws omitted

URL: /en-US/docs/Web/JavaScript/Guide/Regular_expressions
Title: Regular expressions
Flaw count: 8

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
    • and 3 more flaws omitted

URL: /en-US/docs/Web/JavaScript/Guide/Meta_programming
Title: Meta programming
Flaw count: 8

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/JavaScript_basics
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/First_steps
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Building_blocks
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/JavaScript/Objects
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
    • and 3 more flaws omitted

URL: /en-US/docs/Learn_web_development/Core/Scripting/Math
Title: Basic math in JavaScript — numbers and operators
Flaw count: 251

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/Installing_basic_software
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/What_will_your_website_look_like
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/Dealing_with_files
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Learn/Getting_started_with_the_web/HTML_basics
    • and 246 more flaws omitted
External URLs (3)

URL: /en-US/docs/Web/JavaScript/Guide/Internationalization
Title: Internationalization


URL: /en-US/docs/Web/JavaScript/Guide/Numbers_and_strings
Title: Numbers and strings

(comment last updated: 2025-01-14 17:19:28)

Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

Had a scan through, and it's a +1 from me to unblock you

@Josh-Cena Josh-Cena merged commit c16a0ee into mdn:main Jan 14, 2025
10 checks passed
@Josh-Cena Josh-Cena deleted the reorg-guide branch January 14, 2025 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:HTML Hypertext Markup Language docs Content:JS JavaScript docs size/l [PR only] 501-1000 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants