docs: explicit file paths in the tutorial/quick-start#62
Merged
Conversation
A beginner shouldn't have to guess where a file goes. The tutorial now opens with a project-structure tree and labels every file with its full path (myapp/settings.gradle.kts, myapp/build.gradle.kts, myapp/compose.yaml, myapp/src/main/...); quick-start names src/main/resources/application.yml. Both languages. mkdocs build --strict passes.
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
1 participant
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.
Feedback fix: some "create this file" steps didn't say where the file goes (e.g.
compose.yaml).myapp/settings.gradle.kts,myapp/build.gradle.kts,myapp/compose.yaml,myapp/src/main/java/.../MyappApplication.java,myapp/src/main/resources/application.yml.src/main/resources/application.ymlfor its config block.Both languages.
mkdocs build --strictpasses.피드백 반영: 파일 생성 단계에서 위치(경로) 가 빠진 곳들(compose.yaml 등)에 전체 경로 명시 + 프로젝트 구조 트리 추가. en/ko,
--strict통과.