Skip to content

Conversation

@ohah
Copy link
Owner

@ohah ohah commented Nov 2, 2025

docs: API 참조 문서 메뉴 구조 수정

문제점

  • docs/docs/dev/api/commands.mdx 파일이 중첩된 디렉토리에 있어서 RSPress 사이드바 메뉴에 제대로 표시되지 않았습니다
  • "개발하기" 하위 메뉴에서 API 참조 문서를 찾을 수 없었습니다
  • 다음 페이지 네비게이션에도 표시되지 않았습니다

해결 방법

API 참조 문서를 dev/ 디렉토리 루트로 이동하여 메뉴 구조를 단순화했습니다.

변경 사항

  1. 파일 이동: docs/docs/dev/api/commands.mdxdocs/docs/dev/commands.mdx
  2. 메뉴 설정 업데이트: docs/docs/dev/_meta.jsoncommands 항목 추가
  3. 링크 수정: development.mdx의 API 참조 링크를 /dev/api/commands/dev/commands로 변경

변경 파일

  • docs/docs/dev/_meta.json: 메뉴 항목에 commands 추가
  • docs/docs/dev/api/commands.mdxdocs/docs/dev/commands.mdx: 파일 이동
  • docs/docs/dev/development.mdx: API 참조 링크 경로 수정

결과

이제 API 참조 문서가:

  • ✅ "개발하기" 섹션의 사이드바 메뉴에 표시됩니다
  • ✅ 개발 가이드 페이지의 "다음 단계"에서 올바른 링크로 연결됩니다
  • ✅ 페이지 네비게이션(이전/다음)에서 인식됩니다

관련 이슈

문서 네비게이션 및 메뉴 구조 개선

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 reorganizes the documentation structure by simplifying the getting-started guide to focus on end-user installation, moving development setup instructions to the dedicated development guide, and creating a new API reference page for Tauri commands.

  • Simplified getting-started guide by removing development environment setup instructions
  • Fixed broken API reference link in development guide
  • Added new commands.mdx file documenting the Tauri API

Reviewed Changes

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

File Description
docs/docs/guide/getting-started.mdx Removed development setup instructions and replaced with user-friendly installation guide pointing to GitHub releases
docs/docs/dev/development.mdx Updated API reference link from /dev/api/commands to /dev/commands
docs/docs/dev/commands.mdx New API reference documentation for the execute_js Tauri command with usage examples and error handling
docs/docs/dev/_meta.json Updated navigation metadata to reference "commands" instead of "api"

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

@ohah ohah merged commit 3e8369f into main Nov 4, 2025
8 checks passed
ohah added a commit that referenced this pull request Dec 12, 2025
docs: API 참조 문서 메뉴 구조 수정
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants