feat: allow .readme.md filename for top level readme #1769
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
This allows users to hide the readme file in the file list.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds support for .readme.md as an alternative filename for the top-level readme file in spaces. This allows users to hide the readme file from the file list by prefixing it with a dot, which is a common convention for hidden files in Unix-like systems.
Key Changes:
- Modified the readme file detection logic to accept both
readme.mdand.readme.mdfilenames - Updated test configuration to include the resources array in the mock store
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/web-app-files/src/views/spaces/GenericSpace.vue | Updated readme file lookup to check for both readme.md and .readme.md filenames, and changed data source from storeItems to resources |
| packages/web-app-files/tests/unit/views/spaces/GenericSpace.spec.ts | Added resources: files to the test store configuration to support the updated readme lookup logic |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kulmann
approved these changes
Dec 18, 2025
openclouders
pushed a commit
that referenced
this pull request
Dec 18, 2025
feat: allow .readme.md filename for top level readme
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.
This allows users to hide the readme file in the file list.
see #1708 (comment)