Skip to content

docs: restructure README and add backend README - #115

Merged
DenizAltunkapan merged 2 commits into
Vault-Web:mainfrom
Kanishkamangal09:docs/readme-restructure
Aug 5, 2026
Merged

docs: restructure README and add backend README#115
DenizAltunkapan merged 2 commits into
Vault-Web:mainfrom
Kanishkamangal09:docs/readme-restructure

Conversation

@Kanishkamangal09

Copy link
Copy Markdown
Contributor

Summary

This PR restructures the project documentation by simplifying the root README and moving backend specific documentation into a new backend/README.md.

Changes

  • Simplified the root README to serve as a project entry point.
  • Added a new backend/README.md for backend specific documentation.
  • Moved detailed feature documentation from the root README.
  • Moved local development instructions to the backend README.
  • Added dependency information for Vault Web, Deploy, and ClamAV.
  • Added links between the root README and backend documentation.
  • Removed duplicated documentation to keep instructions in a single place.

Closes #113

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR restructures project documentation by slimming down the root README.md into a high-level entry point and moving backend-specific feature and setup documentation into a new backend/README.md, aligning with the goals in issue #113.

Changes:

  • Simplified root README to focus on ecosystem orientation, quick start, and links to deeper docs.
  • Added backend/README.md containing backend responsibilities, feature details, and local development guidance.
  • Centralized detailed documentation to reduce duplication and keep instructions in one place.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.

File Description
README.md Reduced to an entry-point README with feature bullets, quick start, and dependency overview linking to backend docs
backend/README.md New backend-focused README with responsibilities, feature/API details, and local dev + test instructions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread backend/README.md Outdated
Comment thread backend/README.md
Comment thread backend/README.md

@DenizAltunkapan DenizAltunkapan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Kanishkamangal09 thank you for your contribution

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@DenizAltunkapan
DenizAltunkapan merged commit dd9cdb8 into Vault-Web:main Aug 5, 2026
1 check passed
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

Successfully merging this pull request may close these issues.

docs: slim down root README and add backend README

3 participants