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(examples): rename and update documentation #46

Merged
merged 4 commits into from
Dec 21, 2024

Conversation

lumirlumir
Copy link
Owner

This pull request includes renaming and updating documentation for the solutions-readline examples to reflect changes in module support and directory structure. The most important changes include renaming directories and files, updating documentation references, and adding new README files for ESM module examples.

Renaming and updating documentation:

  • Renamed examples/solutions-readline to examples/solutions-readline-cjs and updated all references in README.en.md and README.md to reflect the new directory name. [1] [2] [3] [4]
  • Updated package.json to reflect the new name examples-solutions-readline-cjs.

Adding new README files:

  • Added README.en.md and README.md for examples/solutions-readline-esm to provide documentation for ESM module examples, including instructions on running the examples and clarifying the lack of ESM support in the Baekjoon Node.js environment. [1] [2]

@github-actions github-actions bot added the docs label Dec 21, 2024
Copy link

Labels have been automatically applied based on the conventional commit types.🏷️

@lumirlumir lumirlumir merged commit 4695cf5 into main Dec 21, 2024
3 checks passed
@lumirlumir lumirlumir deleted the docs-examples-readme branch December 21, 2024 16:25
Copy link

codecov bot commented Dec 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.92%. Comparing base (4337944) to head (779ec56).
Report is 1 commits behind head on main.

@@           Coverage Diff           @@
##             main      #46   +/-   ##
=======================================
  Coverage   90.92%   90.92%           
=======================================
  Files           5        5           
  Lines         617      617           
=======================================
  Hits          561      561           
  Misses         56       56           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4337944...779ec56. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant