Skip to content

dcos: 불필요한 설명 제거 #5

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.

Sign up for GitHub

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

Jump to bottom
Merged
ohah merged 6 commits into from
Oct 28, 2025
Merged

dcos: 불필요한 설명 제거 #5

ohah merged 6 commits into from
Oct 28, 2025

Conversation

@ohah
Copy link
Owner

@ohah ohah commented Oct 28, 2025

📚 문서 내용 정리 및 업데이트

📋 변경 사항 요약

이 PR은 ExecuteJS 문서의 내용을 정리하고 현재 프로젝트 상태에 맞게 업데이트합니다.

🔄 주요 변경사항

1. API 문서 간소화 (docs/docs/api/commands.mdx)

  • 불필요한 명령어 설명 제거 (greet, get_js_execution_history, clear_js_execution_history, save_js_code, load_js_code, get_app_info)
  • 핵심 기능인 execute_js 명령어만 유지
  • 타입 정의 섹션 제거로 문서 간소화

2. 개발 가이드 업데이트 (docs/docs/guide/development.mdx)

  • 상태 관리 라이브러리 변경: Legend State → Zustand
  • 린팅 도구 정리: rustfmt + clippy → rustfmt
  • Legend State 관련 예제 코드 및 설명 전체 제거
  • UI 컴포넌트 예제 및 Tailwind CSS 클래스 설명 제거

3. 시작 가이드 간소화 (docs/docs/guide/getting-started.mdx)

  • 실행 기록 관리 섹션 제거
  • 핵심 기능 설명에 집중

4. 라이브 데모 정리 (docs/docs/guide/live-demo.mdx)

  • 모든 라이브 데모 예제 제거
  • "곧 업데이트 하겠습니다!" 메시지로 대체

🎯 목적

  1. 문서 일관성: 실제 구현과 문서 내용의 불일치 해결
  2. 유지보수성: 불필요한 내용 제거로 문서 관리 부담 감소
  3. 사용자 경험: 핵심 기능에 집중된 명확한 문서 제공

🔍 기술적 변경사항

상태 관리

  • 이전: Legend State (반응형 상태 관리)
  • 현재: Zustand (경량 상태 관리)

린팅 도구

  • 이전: rustfmt + clippy
  • 현재: rustfmt

📝 영향받는 파일

docs/docs/api/commands.mdx          # API 명령어 문서 간소화
docs/docs/guide/development.mdx     # 개발 가이드 업데이트
docs/docs/guide/getting-started.mdx # 시작 가이드 간소화
docs/docs/guide/live-demo.mdx        # 라이브 데모 정리

✅ 체크리스트

  • API 문서에서 사용하지 않는 명령어 설명 제거
  • 상태 관리 라이브러리 정보 업데이트 (Legend State → Zustand)
  • 린팅 도구 정보 정리
  • 불필요한 예제 코드 제거
  • 문서 일관성 확보

🚀 다음 단계

  • 라이브 데모 섹션에 새로운 예제 추가 예정
  • Zustand 기반 상태 관리 예제 문서화
  • 실제 프로젝트 기능과 일치하는 API 문서 보완

참고: 이 변경사항은 현재 프로젝트의 실제 구현 상태를 반영하여 문서를 정리한 것입니다.

@ohah ohah requested review from Bori-github and Copilot October 28, 2025 06:10
@ohah ohah self-assigned this Oct 28, 2025
@ohah ohah added the documentation Improvements or additions to documentation label Oct 28, 2025
Copilot AI reviewed Oct 28, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR simplifies ExecuteJS documentation by removing outdated content and updating technical stack information to match the current project implementation.

Key Changes:

  • Removed documentation for unused API commands (greet, execution history management, code save/load, app info)
  • Updated state management library reference from Legend State to Zustand
  • Removed all live demo examples with a placeholder for future updates

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
docs/docs/api/commands.mdx Simplified API documentation to focus only on the core execute_js command
docs/docs/guide/development.mdx Updated tech stack information (Legend State → Zustand, removed clippy from linting tools) and removed code examples
docs/docs/guide/getting-started.mdx Removed execution history management section
docs/docs/guide/live-demo.mdx Removed all interactive demo examples, replaced with update placeholder

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/docs/guide/live-demo.mdx
```

이러한 라이브 데모를 통해 ExecuteJS의 기능을 직접 체험하고 테스트해볼 수 있습니다.
곧 업데이트 하겠습니다!
Copy link

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

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

The spacing in '업데이트 하겠습니다' is incorrect. It should be '업데이트하겠습니다' (no space between the verb stem and auxiliary verb).

Suggested change
곧 업데이트 하겠습니다!
곧 업데이트하겠습니다!

Copilot uses AI. Check for mistakes.
docs/docs/api/commands.mdx
const result = await invoke('execute_js', {
code: 'console.log("Hello, World!");'
const result = await invoke('execute_js', {
code: 'console.log("Hello, World!");',
Copy link

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

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

[nitpick] The trailing comma on line 15 creates inconsistency with the removed code, which didn't have a trailing comma. For single-parameter invocations in the documentation examples, the trailing comma is unnecessary and should be removed for consistency.

Suggested change
code: 'console.log("Hello, World!");',
code: 'console.log("Hello, World!")'

Copilot uses AI. Check for mistakes.
ohah added 5 commits October 28, 2025 15:22
@ohah
feat: 문서에 맞게 사용하지 않는 함수 제거
087e92f
@ohah
refactor(deno_runtime): remove error wrapping and execute code directly
3bf27b9 
- Remove try-catch wrapper around user code
- Execute JavaScript code directly without additional error handling
- This allows natural JavaScript errors to be caught by the runtime
@ohah
refactor(js_executor): simplify error message formatting
f1cc229 
- Remove redundant error message prefixes
- Use direct error formatting without additional context
- This allows raw error messages to be passed through
@ohah
feat(commands): return structured error response instead of string
8aec403 
- Change execute_js return type from Result<JsExecutionResult, String> to Result<JsExecutionResult, JsExecutionResult>
- Return full JsExecutionResult with error details in both result and error fields
- Remove unused greet function
- This allows frontend to receive detailed error information
@ohah
feat(frontend): improve error handling in execution store
0dd267a 
- Remove debug console.log from executeCode function
- Update error handling to use structured error response from backend
- Extract error details from error.result and error.error fields
- Add TODO comment for future error handling improvements
- This allows detailed error messages to be displayed to users
@ohah ohah merged commit a1674f8 into main Oct 28, 2025
6 checks passed
ohah added a commit that referenced this pull request Dec 12, 2025
@ohah
Merge pull request #5 from ohah/docs/content-update
741578c 
dcos: 불필요한 설명 제거
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Bori-github Bori-github Awaiting requested review from Bori-github Bori-github is a code owner

Assignees

@ohah ohah

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ohah