docs(websites-vitepress): cleanup and update documentation #429

lumirlumir · 2025-05-11T13:38:45Z

This pull request includes updates to the Korean documentation for the Banana Framework, focusing on improving clarity, updating compatibility information, and enhancing instructions for users. Key changes include updates to Node.js compatibility, enhancements to installation instructions, and improvements to problem-solving explanations.

Documentation Updates

Node.js Compatibility

Updated the Node.js version compatibility range for the Banana Framework to include ^20.18.0 || ^22.3.0 || >= 24.0.0. This ensures users have the latest and most accurate information on supported versions.

Installation Instructions

Enhanced the create-bananass setup guide with additional instructions, including how to handle prompts during the installation process and details about configuration options. Added a link to the create-bananass CLI documentation for further reference. [1] [2]

Problem-Solving Explanations

Improved the explanation for solving problem 2754 on Baekjoon by detailing the use of JavaScript objects, Map, or switch statements for mapping grades to scores. Added a note on the importance of using trim() to handle input with trailing whitespace.

Minor Text Adjustments

Refined phrasing in the "Getting Started" and "Before Getting Started" sections for better readability and consistency. [1] [2]

Removal of Placeholder Content

Removed a placeholder comment from the problem 2754 solution documentation to reflect the finalized content.

vercel · 2025-05-11T13:38:49Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
npm-bananass-websites-vitepress	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 11, 2025 1:38pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
npm-bananass-websites-eslint-config-bananass	⬜️ Skipped (Inspect)			May 11, 2025 1:38pm

Copilot

Pull Request Overview

This pull request updates the Korean documentation for the Banana Framework by clarifying Node.js compatibility, refining installation instructions, and improving the explanation for problem 2754.

Updated Node.js compatibility range and installation steps with clear CLI instructions.
Enhanced the problem-solving explanation for problem 2754 with detailed mapping strategies and input trimming usage.
Made minor text adjustments in the "Before Getting Started" section for improved readability.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
websites/vitepress/ko/solutions/baekjoon/2754.md	Improved explanation for mapping grades and handling input, with removal of placeholder content.
websites/vitepress/ko/get-started/installation.md	Updated Node.js compatibility info and enhanced CLI installation instructions with interactive examples.
websites/vitepress/ko/get-started/before-getting-started.md	Minor text adjustment to clarify the description of problem-solving approaches.

websites/vitepress/ko/solutions/baekjoon/2754.md

codecov · 2025-05-11T13:39:43Z

Bundle Report

Changes will decrease total bundle size by 28.81kB (-1.1%) ⬇️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
websites-vitepress-esm	2.26MB	-28.81kB (-1.26%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: websites-vitepress-esm

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`@localSearchIndexroot.*.js`	-8.07kB	111.96kB	-6.72%
`solutions_baekjoon_2754.*.js`	475 bytes	47.0kB	1.02%
`get-started_installation.*.js`	12.29kB	23.36kB	111.02% ⚠️
`get-started_before-getting-started.*.js`	6 bytes	17.81kB	0.03%
`apis_eslint-config-bananass.*.js`	-33.51kB	17.48kB	-65.71%

Files in solutions_baekjoon_2754.*.js:

./ko/solutions/baekjoon/2754.md → Total Size: 47.63kB

Files in get-started_installation.*.js:

./ko/get-started/installation.md → Total Size: 21.19kB

Files in get-started_before-getting-started.*.js:

./ko/get-started/before-getting-started.md → Total Size: 12.72kB

Files in apis_eslint-config-bananass.*.js:

./ko/apis/eslint-config-bananass.md → Total Size: 16.56kB

github-actions · 2025-05-11T13:40:29Z

Labels have been automatically applied based on the Conventional Commits specification.🏷️

codecov · 2025-05-11T13:41:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.30%. Comparing base (3f390b9) to head (bd5a593).

@@           Coverage Diff           @@
##             main     #429   +/-   ##
=======================================
  Coverage   97.30%   97.30%           
=======================================
  Files         195      195           
  Lines       11125    11125           
  Branches       28       28           
=======================================
  Hits        10825    10825           
  Misses        300      300

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 3f390b9...bd5a593. Read the comment docs.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@lumirlumir

….0` (`patch`) (#437) ## Release Information: `v0.1.0` New release of `lumirlumir/npm-bananass` has arrived! 🎉 This PR bumps the package versions from `v0.1.0-canary.6` to `v0.1.0` (`patch`). See [Actions](https://github.com/lumirlumir/npm-bananass/actions/runs/14977582819) for more details. | Info | Value | | ----------- | -------------------------- | | Repository | `lumirlumir/npm-bananass` | | SEMVER | `patch` | | Pre ID | `canary` | | Short SHA | fe675c7 | | Old Version | `v0.1.0-canary.6` | | New Version | `v0.1.0` |  ## What's Changed ### 💥 BREAKING CHANGES * chore(*)!: drop support for Node.js 23 by @lumirlumir in #425 ### 📝 Documentation * docs(*): create more examples and solutions by @lumirlumir in #418 * docs(websites-vitepress): fix the ordering of solution files in sidebar by @lumirlumir in #424 * docs(websites-vitepress): complete `quick-start.md` by @lumirlumir in #426 * docs(*): add example for BOJ Problem 30802 by @sukjuhong in #427 * docs(websites-vitepress): cleanup and update documentation by @lumirlumir in #429 * docs(*): add example for BOJ Problem 28702 (FizzBuzz) by @sukjuhong in #433 * docs(websites-vitepress): cleanup documentation for a beta release by @lumirlumir in #436 ### ♻️ Code Refactoring * refactor(*): remove `.js` extension in `describe` block by @sukjuhong in #422 * refactor(bananass): remove `lint` command and consolidate with `build` by @lumirlumir in #434 * refactor(bananass): cleanup `run` command by @lumirlumir in #435 ### ⬆️ Dependency Updates * chore(deps): bump globals from 16.0.0 to 16.1.0 by @dependabot in #419 * chore(deps-dev): bump @types/node from 22.15.16 to 22.15.17 by @dependabot in #420 * chore(deps): bump eslint-plugin-n from 17.17.0 to 17.18.0 by @dependabot in #430 * chore(deps-dev): bump lint-staged from 15.5.2 to 16.0.0 by @dependabot in #431 **Full Changelog**: v0.1.0-canary.6...v0.1.0

lumirlumir added 2 commits May 11, 2025 22:16

wip

90028d8

wip

bd5a593

Copilot AI review requested due to automatic review settings May 11, 2025 13:38

Copilot AI reviewed May 11, 2025

View reviewed changes

websites/vitepress/ko/solutions/baekjoon/2754.md Show resolved Hide resolved

lumirlumir changed the title ~~docs(website-vitepress): cleanup and update documentation~~ docs(websites-vitepress): cleanup and update documentation May 11, 2025

github-actions bot added 🏷️ scope: websites-vitepress Auto-generated label based on Conventional Commits specification for GitHub release notes 🏷️ type: docs Auto-generated label based on Conventional Commits specification for GitHub release notes labels May 11, 2025

lumirlumir merged commit 6846f96 into main May 11, 2025
22 of 23 checks passed

lumirlumir deleted the docs-cleanup-documentation branch May 11, 2025 13:42

This was referenced May 10, 2025

Roadmap to v1.0.0 #254

Open

chore(release): bump package versions from v0.1.0-canary.6 to v0.1.0 (patch) #437

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs(websites-vitepress): cleanup and update documentation #429

docs(websites-vitepress): cleanup and update documentation #429

Uh oh!

lumirlumir commented May 11, 2025

Uh oh!

vercel bot commented May 11, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

codecov bot commented May 11, 2025 •

edited

Loading

Assets Changed:

Uh oh!

github-actions bot commented May 11, 2025

Uh oh!

codecov bot commented May 11, 2025

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

docs(websites-vitepress): cleanup and update documentation #429

docs(websites-vitepress): cleanup and update documentation #429

Uh oh!

Conversation

lumirlumir commented May 11, 2025

Documentation Updates

Node.js Compatibility

Installation Instructions

Problem-Solving Explanations

Minor Text Adjustments

Removal of Placeholder Content

Uh oh!

vercel bot commented May 11, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

codecov bot commented May 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Affected Assets, Files, and Routes:

Assets Changed:

Uh oh!

github-actions bot commented May 11, 2025

Uh oh!

codecov bot commented May 11, 2025

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

codecov bot commented May 11, 2025 •

edited

Loading