starknet docs
v0.1.514
Starknet Docs 웹 사이트 인 https://docs.starknet.io는 Asciidoc에서 작성되었으며 Asciidoc의 정적 웹 사이트 생성기 인 Antora를 사용하여 구축됩니다.
Starknet 기술 문서에 기여하는 데 관심이 있다면 다음 표는 시작하는 데 도움이되는 빠른 링크를 제공합니다.
질문 | 의지 |
관심이 있습니다. 어떻게 기여합니까? | 기여 방법에 대한 정보는 기여하는 다른 방법을 참조하십시오. |
나를 도울 기본 지침이 있습니까? | 콘텐츠를 일관되게 유지하는 데 도움이되는 기본 지침은 문서 지침을 참조하십시오. |
내가 사용해야 할 스타일 가이드와 글쓰기 가이드가 있습니까? | Starknet Documentation 보충 스타일 가이드를 참조하십시오. |
워크 스테이션을 어떻게 설정합니까? | 환경 설정을 참조하십시오. |
Starknet 문서에 기여할 수있는 몇 가지 방법이 있습니다.
GitHub 문제를 만듭니다.
풀 요청 (PR)을 제출하십시오. Starknet-Docs 저장소의 자신의 포크 클론을 만들고 변경하고 PR을 제출할 수 있습니다. 이 옵션은 상당한 변경 사항이 있거나 변경 사항을 더 빨리 추가하려는 경우 가장 좋습니다.
PR을 제출하면 어떻게됩니까?
PR을 제출할 때 Starknet Docs 팀은 PR을 검토하고 필요에 따라 추가 기술 검토를 준비합니다. PR에 변경이 필요한 경우 검토자는 PR에 주석을 추가합니다. 우리는 귀하가 변경하도록 요청하거나 귀하의 콘텐츠를 다른 PR에 통합했음을 알려줄 수 있습니다. 때때로, 우리는 원래 PR에 직접 커밋을 추가 할 수 있습니다. PR을 검토하고 모든 업데이트가 완료되면 문서 팀이 PR을 병합하여 유효한 버전에 적용합니다.
Starknet Documentation 보충 스타일 가이드 : 일반 스타일 지침 및 쓰기 지침.
Asciidoc에서의 글쓰기에 대한 자세한 내용은 다음을 참조하십시오.
Asciidoc 언어 문서
Asciidoc 구문 빠른 참조
메모 | ID, 소스 코드 블록, 상호 참조 및 링크를 코딩하는 여러 가지 방법이 있습니다. 일반적으로 코드 가독성 우선 순위를 정하기 위해 코딩에 가장 명백한 코딩 규칙을 사용합니다. 이러한 코딩 규칙의 대부분은 Red Hat 문서에 대한 Asciidoc 마크 업 빠른 참조에 나열되어 있습니다. |
yarn 아직 설치되지 않은 경우 설치하십시오.
npx 아직 설치되지 않은 경우 설치하십시오.
포크에서 또는 공식 공동 작업자 인 경우 starknet-io/starknet-docs 에서 직접이 저장소를 복제하십시오.
starknet-docs 디렉토리로 변경하십시오.
yarn 명령을 실행하여 환경을 준비하십시오.
방사
yarn package-lock.json 및 package.json 기반으로 필요한 모듈을 설치하여 환경을 준비해야합니다. 성공한 경우 컨텐츠를 빌드하고 미리 볼 수 있어야합니다.
컨텐츠를 작성하거나 편집 한 후 변경 사항을 미리 봅니다.
build_local_site.sh 빌드 스크립트를 실행하여 컨텐츠를 빌드하십시오.
./build_local_site.sh 이 명령은 directory public_html 에서 웹 사이트를 생성합니다.
다음 중 하나를 수행하여 웹 사이트를 엽니 다.
시작 페이지를 엽니 다 : <repo_root>/public_html/index.html .
Antora로 패키지 된 HTTP 서버를 실행하십시오.
npx http-server public_html -c-1서버는 실행되며 웹 사이트를 보는 데 사용할 수있는 하나 이상의 로컬 URL을 제공합니다. 예를 들어:
Starting up http-server, serving public_html
...
Available on:
http://127.0.0.1:8080
http://192.168.68.111:8080
http://192.168.14.3:8080
http://10.14.0.2:8080
Hit CTRL-C to stop the server이 저장소의 문서를 공개하기위한 고급 프로세스는이 저장소에서 변경됩니다.
콘텐츠 개발 과정에서 작가는 지점을 직접 main , 필요에 따라 2 차 지점으로 병합합니다. 이러한 변경 사항은 우리가 공개 할 준비가 될 때까지 기다립니다. 즉, Docs.starknet.io에 게시합니다.
GitHub 작업은 Repo의 릴리스 및 태그 페이지에 나타나는 GIT 태그 및 릴리스를 만듭니다.
기능 분기가 main 브랜치로 병합되면 GitHub 액션은 형식 v <버전 CHANGELOG.md v<version>.<major_update>.<minor_update> 그런 다음 새로운 콘텐츠를 Docs.starknet.io에 게시합니다.
기능 분기를 main 으로 병합하면 기능 분기의 변경 사항이 자동으로 게시됩니다. 추가 단계가 필요하지 않습니다.
GitHub는 package.json 및 package-lock.json 의 버전 번호를 증가시키고 방금 main 으로 병합 된 각 PR의 설명으로 CHANGELOG.md 업데이트합니다. . 다음 중 하나를 사용하여 원격 main 지점에서 로컬 main 브랜치를 업데이트하십시오.
변경 사항을 당기십시오 :
starknet-docs (main) git pull [email protected]:starknet-io/starknet-docs.git 에서 Rebase를 수행하십시오.
starknet-docs (main) git fetch origin
starknet-docs (main) git rebase origin/main 메모 | 포크를 사용하는 경우, 포크 리포지기는 기본적으로 |
