Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit README by adding table of contents and update overview, notices and disclaimers #498

Merged
merged 8 commits into from
Jan 15, 2025

Conversation

marycrawford
Copy link
Collaborator

@marycrawford marycrawford commented Jan 6, 2025

Description

Update the IDWA ReportVision Project README with an detailed overview with a problem, solution and future consideration statement, as well as revise the disclaimers and notices. I added a table of contents to make it easier for readers to navigate the README.

Related Issues

#513

Checklist

  • The title of this PR is descriptive and concise.
  • My changes follow the style guidelines of this project.
  • I've let the team know about this PR by linking it in the review channel

@marycrawford marycrawford changed the title Update readme toc and disclaimers Edit README by adding table of contents and updating disclaimers and notices Jan 6, 2025
@marycrawford marycrawford marked this pull request as draft January 6, 2025 07:29
@marycrawford marycrawford self-assigned this Jan 6, 2025
@marycrawford marycrawford changed the title Edit README by adding table of contents and updating disclaimers and notices Edit README by adding table of contents and updating overview, notices and disclaimers Jan 6, 2025
@marycrawford marycrawford added the documentation Improvements or additions to documentation label Jan 6, 2025
@marycrawford marycrawford changed the title Edit README by adding table of contents and updating overview, notices and disclaimers Edit README by adding table of contents and update overview, notices and disclaimers Jan 6, 2025
@marycrawford marycrawford marked this pull request as ready for review January 15, 2025 11:14
derekadombek
derekadombek previously approved these changes Jan 15, 2025
@derekadombek
Copy link
Collaborator

I Approved but looks like you have some conflicts. Might be from Arin's recent changes.

Copy link
Collaborator

@arinkulshi-skylight arinkulshi-skylight left a comment

Choose a reason for hiding this comment

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

LG to me. Conflicts should be resolved!

@marycrawford marycrawford added this pull request to the merge queue Jan 15, 2025
Merged via the queue into main with commit 8f25713 Jan 15, 2025
1 check passed
@marycrawford marycrawford deleted the update-readme-toc-and-disclaimers branch January 15, 2025 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants