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: Improve DX #215

Open
4 tasks
kms0219kms opened this issue Jan 8, 2025 · 1 comment
Open
4 tasks

docs: Improve DX #215

kms0219kms opened this issue Jan 8, 2025 · 1 comment

Comments

@kms0219kms
Copy link
Contributor

개요

최근 프리텐다드 폰트를 사용하는 많은 웹 개발 업계에서의 고충과 피드백을 들어 왔습니다.

이 중 몇 가지는, 문서 개선을 통해서 해결이 가능해 보여,
대대적으로 문서를 개편하는 작업을 해보는 것이 어떨까 싶습니다.

html 하고 css 둘다 병기 되어있으니까
둘다 써야 되나? 부터 시작해서
가변 서체는 뭐고 다이나믹 서브셋은 뭐고

대표적으로 제가 받았던 피드백 내용입니다. 이러한 피드백을 바탕으로, "설치 방법에 대해, 실제 설치과정보다 피로도가 높은 상황" 이라는 결론에 이르렀고, 문서 개편이 필요하다고 느꼈습니다.

수정 건의사항

위 문제를 해결하기 위해서, 제가 생각한 수정 사항들입니다.

  • Wanted Sans 처럼 웹폰트 설치 안내를 다른 파일로 옮기기 (주의: 웹폰트로 이용이 가능하다는 내용이 눈에 안 띌 수 있음)
  • "추천"하는 (가장 간단하고, 성능이 좋은) 이용 방법 하나만 기본적으로 노출하기 (같은 방법이라도 cdn 등 통일)
  • 추천방법 이외에는 detail 태그 밑으로 넣어버리기
  • Next.js 에서 폰트를 불러오는 방법을 하나로 통일하여 명시적으로 문서화 (example에서는 local font로 불러오나, 문서에서는 css import 방식으로 되어있음)

위 3가지 모두 문서에 대한 Breaking Change가 요구되어, 이슈를 먼저 raise 해서 많은 분들께서 참여하실 수 있으면 하는 바램입니다.

@kms0219kms
Copy link
Contributor Author

Google Fonts 빌드가 만약 설에 성공하고, Google Fonts에 올라간다면, 이 문서 개편 작업과 함께 진행되면 좋을 듯 합니다.

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