Repository navigation
docs: introduce RCP capabilities and architecture in README - #95
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
변경 내용
프로젝트의 기능과 구조를 첫 화면에서 파악할 수 있도록 README를 재구성합니다. Compute, Storage, Access, Functions 및 함수 데이터 기능을 소개하고, Mermaid 구성도 3개와 개발 가이드 링크를 추가했습니다. 플랫폼 링크는 https://khu-return.com 을 사용합니다.
기존 실행·함수 프로토콜·SSH·배포·장애 대응 문서는 접기 영역에 그대로 보존했습니다. 실제 콘솔 캡처나 별도 이미지 파일 없이 README 하나만 변경합니다.
검증
문서만 변경하여 애플리케이션 테스트는 별도로 실행하지 않았습니다.
CI 결과
최신 커밋에서 테스트, 린트, 생성 문서, 포맷 및 모듈, 4개 바이너리 빌드 등 8개 검사가 통과했습니다. Vulnerability Scan은 기존 Go 1.26.6 및 golang.org/x/net v0.57.0 관련 취약점으로 실패했습니다. 이 PR은 README.md만 변경하며 코드와 의존성은 수정하지 않습니다.
검사 로그: https://github.com/KHU-RETURN/rcp-server/actions/runs/37868828917/job/113621936097