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

Add simple example and import statement to logger API docs #8787

Closed
1 of 2 tasks
Zenahr opened this issue Mar 17, 2023 · 5 comments · Fixed by #9210
Closed
1 of 2 tasks

Add simple example and import statement to logger API docs #8787

Zenahr opened this issue Mar 17, 2023 · 5 comments · Fixed by #9210
Assignees
Labels
documentation The issue is related to the documentation of Docusaurus

Comments

@Zenahr
Copy link
Contributor

Zenahr commented Mar 17, 2023

Have you read the Contributing Guidelines on issues?

Description

Affecting: https://docusaurus.io/docs/api/misc/@docusaurus/logger

At the very least, having sample code on how to import the logger and at one logger call would be great (simple usage, besides the template literal method, e.g. logger.green("some text")). That way, readers wouldn't have to browse the Docusaurus source code just to know how to use the logger package.

The logger is useful not just for plugin authors, but also if you've got any complex React components you'd like some logging on for errors etc.

Self-service

  • I'd be willing to address this documentation request myself.
@Zenahr Zenahr added documentation The issue is related to the documentation of Docusaurus status: needs triage This issue has not been triaged by maintainers labels Mar 17, 2023
@Josh-Cena Josh-Cena removed the status: needs triage This issue has not been triaged by maintainers label Mar 17, 2023
@Josh-Cena Josh-Cena self-assigned this Mar 17, 2023
@ArslanYM
Copy link

Can i work on this?

@Josh-Cena
Copy link
Collaborator

@ArslanYM Thanks, but I will work on this myself. It's already assigned.

@ArslanYM
Copy link

ok john cena

@Zenahr
Copy link
Contributor Author

Zenahr commented Mar 21, 2023

@ArslanYM if you're eager to contribute, feel free to take on my MR #8704 (I was going to work on this in a couple days, but if you'd like you can continue it.)

@ArslanYM
Copy link

I would love to work on this #8704 but its kind of unclear to me what exactly im supposed to do

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation The issue is related to the documentation of Docusaurus
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants