docs: itdoc docs generate

[wnghdcjfe]

https://docusaurus.io/docs 을 이용한 문서화작업 초안완성

• discord,author, github 관련 링크 정리
• docs 초안

추후 재송님이 할부분

• getting started
• 테스트 세부 내용 정리
• github pages에 배포(npm run build -> build 폴더에 빌드됩니다.)

고민할 사항
이 문서 작업에 필요한 패키지는 다음과 같습니다.

    "dependencies": {
        "@docusaurus/core": "3.7.0",
        "@docusaurus/preset-classic": "3.7.0",
        "@mdx-js/react": "^3.0.0",
        "clsx": "^2.0.0",
        "prism-react-renderer": "^2.3.0",
        "react": "^19.0.0",
        "react-dom": "^19.0.0"
    },

이거를 우리 기존 itdoc에 넣게 되면 무겁게 됩니다.
지금은 해당 부분과 itdoc이 무관하도록 itdoc-doc 자체내의 package.json 이 있는 형식입니다.

        "docs": "cd itdoc-doc && pnpm install && pnpm run start"

만약 root package.json에 넣는다면
devdependencies에 넣는게 정해인 것같은데 어떻게 하는게 좋을까요?
-> 현재는 itdoc-doc내부의 package.json에 넣어서 진행하겠습니다. 추후 좀 더 논의 해보죠.

relate #14

[PENEKhun]

이거를 우리 기존 itdoc에 넣게 되면 무겁게 됩니다.
지금은 해당 부분과 itdoc이 무관하도록 itdoc-doc 자체내의 package.json 이 있는 형식입니다.
"docs": "cd itdoc-doc && pnpm install && pnpm run start"
만약 root package.json에 넣는다면
devdependencies에 넣는게 정해인 것같은데 어떻게 하는게 좋을까요?

위 질문 답변 :

별도의 itdoc-doc 모듈로 분리하지 않고, 루트 dev종속성으로 넣는게 좋을 것 같습니다.

• 개발 종속성으로 넣는 이유 :
  • (어짜피 직접 run으로 실행하는 경우는 없지 않을까? 생각이 들어서요. 대부분 build한 아티팩트를 업로드하는 사용이 전부일 것 같아서.)

---

질문 :

페이지는 netlify로 호스팅하실 건가요? 아니면 github pages를 사용하실 건가요?

저는 별도의 CI 파이프라인에서 문서만 정적 html로 만들어서 -> github pages로 호스팅 하는게 좋을 것 같습니당!!

---

추가 질문 :
정적 페이지로 만드는데, 종속성으로 리액트 까지 필요할까요?

물론 이쁘게 커스터마이징 할 수 있다는 장점이 있을거같긴한데, 너무 복잡하고 무겁다는 생각이 들어서요

그냥 기본 셋팅을 잘 수정하는게 낫지 않을까? 라는 생각이 들었습니당

• https://docusaurus.io/docs/api/themes/configuration

요부분은 @cjs1301 님의 의견도 궁금합니다.

[PENEKhun]

아이돌 응원 합니다 👏

[wnghdcjfe]

_< 올해 데뷔에요

[PENEKhun]

(혼잣말임) 좀 더 생각해보니 무겁더라도 이쁜게 장땡이 아닌가?? 라는 생각도 들긴하네요 ㅎㅎ

[wnghdcjfe]

제가 문서화 작업하는데 쓰이는 도구가 페이스북에서 만든
docusaurus인데요 ㅎㅎ 이게 리엑트기반으로 되어있어서 리엑트는 무조건 필요합니다. @PENEKhun

별도의 itdoc-doc 모듈로 분리하지 않고, 루트 dev종속성으로 넣는게 좋을 것 같습니다.
-> dev로 가겠습니다. pakcage.json내의 dev로 말씀하시는거죠?

페이지는 netlify로 호스팅하실 건가요? 아니면 github pages를 사용하실 건가요?
저는 별도의 CI 파이프라인에서 문서만 정적 html로 만들어서 -> github pages로 호스팅 하는게 좋을 것 같습니당!!
-> 이거는 좀 논의 해봐야할것같아요 저는 둘다 괜찮습니다.

[cjs1301]

"이거를 우리 기존 itdoc에 넣게 되면 무겁게 됩니다. 지금은 해당 부분과 itdoc이 무관하도록 itdoc-doc 자체내의 package.json 이 있는 형식입니다."

• 저는 이대로 가는게 맞다고 생각합니다!
  무거워 지는것도 있겠지만, 저희 라이브러리의 기능과 상관없는 문서를 위한 의존성들이 들어가는데 root로 들어가게 된다면
  내부적으로 쓰이는 종속성관리까지 생각지못한 이슈(문서생성을 위해 추가한 종속성이 기존 코드에 영향을 주는)가 생길수 있을것 같습니다.

"저는 별도의 CI 파이프라인에서 문서만 정적 html로 만들어서 -> github pages로 호스팅"

• 이 쪽이 좋을것 같습니다. 타 서비스를 이용하면 아이디 관리할게 하나더 늘어나는것이 아직 과하다는 생각입니다.

[PENEKhun]

dev로 가겠습니다. pakcage.json내의 dev로 말씀하시는거죠?

@wnghdcjfe

네 맞습니다

[PENEKhun]

저는 이대로 가는게 맞다고 생각합니다!
무거워 지는것도 있겠지만, 저희 라이브러리의 기능과 상관없는 문서를 위한 의존성들이 들어가는데 root로 들어가게 된다면
내부적으로 쓰이는 종속성관리까지 생각지못한 이슈(문서생성을 위해 추가한 종속성이 기존 코드에 영향을 주는)가 생길수 있을것 같습니다.

만약 이렇게 가시려면 itdoc-doc을 workspace에 포함시켜야 될 듯해욤

[wnghdcjfe]

음..
지금 그러면 의견이 2개로 쪼개진거네용?

• root - package.json 내의 dev 의존성으로 가느냐
• itdoc-doc내의 package.json내로 가느냐...

흠...

"저는 별도의 CI 파이프라인에서 문서만 정적 html로 만들어서 -> github pages로 호스팅"
-> 이렇게 가겠습니다.

[wnghdcjfe]

참고로 현재 완성된 골조는 다음과 같습니다. blog 또한 할 수 있습니다.

추후 dark, light 모드에 대한 color palette에 대한 논의가 필요합니다. 적당한 색깔 4개의 포인트 색깔을 정해야 합니다.

[PENEKhun]

참고로 현재 완성된 골조는 다음과 같습니다. blog 또한 할 수 있습니다.

추후 dark, light 모드에 대한 color palette에 대한 논의가 필요합니다. 적당한 색깔 4개의 포인트 색깔을 정해야 합니다.

아이콘은 저거로 쭉 가는건가요??

[wnghdcjfe]

음... 일단은 저걸로 가는데 더 귀여운게 있으면 투표후 그걸로 가시죠.

[cjs1301]

수고 하셨습니다!!
추가적으로 수정이 필요한 부분들은 추후 작업할때 적용하겠습니다!

[PENEKhun]

디자인 깔끔하네요. 전업이라 하셔도 믿겠는걸요? ㅎㅎ
아래 부분만 한번 확인해주시고, 병합부탁드립니다!

---

itdoc-doc 디렉토리에서 pnpm install를 실행해도, itdoc-doc에 대한 종속성 설치가 되지 않습니다...
아마 홍철님은 npm install로 하시지 않았을까 라는 생각이 드는데요

이 부분 한번 확인해주시고,
pnpm install로도 설치 가능하게 통일해주시면 감사드리겠습니다. 🙇🏻

[wnghdcjfe]

root - package.json내에서 관리하려고 했지만... type:module을 지원하지 않는 관계로 해당 폴더내에서 관리하는 것으로 변경됩니다.
facebook/docusaurus#6520