Skip to content

[Feature] 개발자, 사용자를 위한 Documentation 웹 페이지 생성 #550

@Boksam

Description

@Boksam

기능 설명 및 필요성

현재 개발자를 위한 Documentation과 사용자를 위한 Documentation이 제대로 관리되고 있지 않습니다.

사용자를 위한 문서는 Notion Page를 사용하고 있지만, 가독성이 떨어질 뿐더러 필수적인 정보들이 포함되어 있지 않아 개선이 필요합니다.

문서를 보충하면서 개발자 및 사용자를 위한 통합 Documentation 페이지를 Github Pages 를 사용해 호스팅하고, 코드플레이스에 About과 같은 탭으로 링크를 거는 것이 가장 좋은 방법으로 생각됩니다.

  • 이 참에 체계적으로 문서 관리 방법을 확정할 필요가 있습니다.

예상 동작 방식

Github Pages를 이용해 Documentation 페이지를 생성합니다.
이 Documentation 페이지는 Developer 및 User 모두를 포함해야 하고, 첫 페이지에서 분기할 수 있도록 수정해야 합니다.

참고 자료

N/A

Acceptance Criteria

  • 최대한 깔끔한 Theme을 찾아 Github Pages로 호스팅 (Jekyll 혹은 Hugo가 좋을 것 같습니다)
  • Github Action을 추가하여 문서가 업데이트 될때마다 자동으로 업데이트 될 수 있도록 설정
  • (Optional) 최대한 모노레포 안에서 문서를 포함할 수 있도록 구성

Metadata

Metadata

Assignees

Labels

documentation문서 작성 시 지정합니다.

Projects

Status

In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions