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

Update CSP docs #149

Merged
merged 21 commits into from
Aug 26, 2024
Merged

Update CSP docs #149

merged 21 commits into from
Aug 26, 2024

Conversation

sajith
Copy link
Member

@sajith sajith commented Aug 8, 2023

Issue is #137. Changes:

  • Consolidate docs and images under docs folder.
  • Remove old/unused test data files and references to those files from the doc.
  • Formatting changes.

This is not ready yet. I have added some TODO items in the doc. I will need some help/hand-holding there.

@sajith sajith added the documentation Improvements or additions to documentation label Aug 8, 2023
@sajith sajith self-assigned this Aug 8, 2023
@sajith sajith linked an issue Aug 8, 2023 that may be closed by this pull request
@sajith sajith added the help wanted Extra attention is needed label Aug 8, 2023
@coveralls
Copy link

coveralls commented Aug 20, 2024

Pull Request Test Coverage Report for Build 10563024958

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 86.016%

Totals Coverage Status
Change from base Build 10479975493: 0.0%
Covered Lines: 1124
Relevant Lines: 1271

💛 - Coveralls

@YufengXin YufengXin self-requested a review August 23, 2024 16:10
@YufengXin
Copy link
Collaborator

@sajith I updated the readme, please check and merge into main. It definitely could use more contents, but it's more accurate and updated now. Thanks.

Copy link
Collaborator

@YufengXin YufengXin left a comment

Choose a reason for hiding this comment

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

needs proofreading and further edits from Sajith

@YufengXin YufengXin marked this pull request as ready for review August 24, 2024 19:13
@sajith
Copy link
Member Author

sajith commented Aug 26, 2024

@YufengXin Let us merge this now. It would be useful to have a detailed description of the diagram (what the yellow, green, and blue regions and the numbers mean) and how that relates to code, but that can be a later step.

@sajith sajith merged commit de3e571 into main Aug 26, 2024
10 checks passed
@sajith sajith deleted the 137.update-doc branch August 26, 2024 16: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 help wanted Extra attention is needed
Projects
Development

Successfully merging this pull request may close these issues.

Update documentation
3 participants