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] 페이지 편집 클릭 이동시 404 문제 #118

Open
clockk opened this issue Nov 30, 2024 · 0 comments
Open

[docs] 페이지 편집 클릭 이동시 404 문제 #118

clockk opened this issue Nov 30, 2024 · 0 comments

Comments

@clockk
Copy link
Contributor

clockk commented Nov 30, 2024

안녕하세요
pie docs 문서에서 [페이지 편집] 클릭시 이동되는 README.md의 페이지가 404가 뜨고있습니다

docs의 모든 패키지에서 동일하게 발생하고 있으며
예시로, 아래 페이지에 최하단의 [페이지 편집] 클릭시 재연 가능합니다
https://naverpaydev.github.io/pie/docs/docs/@naverpay/es-http-status-codes/

확인 결과 app/docs 내부의 패키지 디렉토리 구조와, 깃허브 pie 리포지토리의 구조가 일치하지 않아 404가 뜨고있습니다.
pie 패키지의 예시로, pie 프로젝트 디렉토리는 app/docs/@naverpay/* 지만
실제 깃허브의 pie 리포지토리 구조는 app/docs/* 입니다

이를 해결하기위해 두가지 방법이 있습니다.

  1. apps/docs/@naverpay/* 구조가 아닌, apps/docs/* 사용
  2. docusaurus.config 내에 editURL 변경
as-is
editUrl: (params) => `https://github.com/NaverPayDev/pie/tree/main/packages/${params.docPath}`,

to-be
editUrl: (params) => {
    const docPath = params.docPath.startsWith('@naverpay')
        ? params.docPath.replace('@naverpay/', '')
        : params.docPath
    return `https://github.com/NaverPayDev/pie/blob/main/packages/${docPath}`
},

위 두가지 외에 더 좋은 방법이 있을 수 있습니다.
기여가 필요하다면 수정 방안이 결정된 후에 PR을 생성하겠습니다

감사합니다

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

No branches or pull requests

1 participant