Skip to content

docs: improve README clarity and open-source structure - #403

Open
igoroctaviano wants to merge 1 commit into
masterfrom
docs/improve-readme
Open

docs: improve README clarity and open-source structure#403
igoroctaviano wants to merge 1 commit into
masterfrom
docs/improve-readme

Conversation

@igoroctaviano

Copy link
Copy Markdown
Collaborator

Summary

  • Rewrite the README for clearer language without removing existing content
  • Fix typos, broken TOC anchors (e.g. Authentication), and the outdated dicom-microscopy-viewer link
  • Add standard open-source sections shared with dicom-microscopy-viewer: License, Contributing, Prerequisites, Related projects, and a scripts table
  • Align formatting (badges, TOC, code fences, section order) with the companion dmv README PR

Companion PR: ImagingDataCommons/dicom-microscopy-viewer docs/improve-readme

Test plan

  • Preview the rendered README on GitHub
  • Click through Table of Contents anchors
  • Confirm screenshots and external demo links still resolve
  • Confirm LICENSE and CONTRIBUTING.md links work

Rewrite for clearer language, fix typos and broken TOC anchors, and add
standard sections (license, contributing, prerequisites, related projects)
aligned with dicom-microscopy-viewer.
@sonarqubecloud

Copy link
Copy Markdown

@deepsource-io

deepsource-io Bot commented Jul 31, 2026

Copy link
Copy Markdown

DeepSource Code Review

We reviewed changes in 7751f2b...c483343 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade   Security  

Reliability  

Complexity  

Hygiene  

Code Review Summary

Analyzer Status Updated (UTC) Details
JavaScript Jul 31, 2026 7:47p.m. Review ↗

Important

AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.

@github-actions

Copy link
Copy Markdown

Visit the preview URL for this PR (updated for commit c483343):

https://idc-external-006--pr403-docs-improve-readme-qnx3a17j.web.app

(expires Fri, 07 Aug 2026 19:49:50 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 88aacecd98ba54d2f9c8d201a9444e43d1ad8307

@igoroctaviano
igoroctaviano requested a review from fedorov July 31, 2026 19:50
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.

1 participant