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

feat(docs): Improve documentation and enforce markdown linting #16252

Open
wants to merge 106 commits into
base: main
Choose a base branch
from

Conversation

AndesKrrrrrrrrrrr
Copy link
Member

No description provided.

Copy link
Contributor

coderabbitai bot commented Oct 3, 2024

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

35 files out of 117 files are above the max files limit of 75. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 38.12%. Comparing base (7b20920) to head (45a68f5).
Report is 16 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #16252      +/-   ##
==========================================
+ Coverage   36.92%   38.12%   +1.20%     
==========================================
  Files        6781     6063     -718     
  Lines      140014   127288   -12726     
  Branches    39811    36805    -3006     
==========================================
- Hits        51703    48534    -3169     
+ Misses      88311    78754    -9557     
Flag Coverage Δ
air-discount-scheme-backend 54.22% <ø> (ø)
air-discount-scheme-web 0.00% <ø> (ø)
api 3.37% <ø> (ø)
api-catalogue-services ?
api-domains-air-discount-scheme 36.95% <ø> (ø)
api-domains-assets 26.71% <ø> (ø)
api-domains-auth-admin 48.77% <ø> (ø)
api-domains-communications 39.92% <ø> (ø)
api-domains-criminal-record 47.93% <ø> (ø)
api-domains-driving-license 44.48% <ø> (ø)
api-domains-education 31.74% <ø> (ø)
api-domains-health-insurance 34.78% <ø> (ø)
api-domains-license-service ?
api-domains-mortgage-certificate 35.71% <ø> (ø)
api-domains-payment-schedule 41.22% <ø> (ø)
application-api-files 57.91% <ø> (ø)
application-core 71.62% <ø> (+0.32%) ⬆️
application-system-api 41.63% <ø> (+<0.01%) ⬆️
application-template-api-modules 24.38% <ø> (ø)
application-templates-accident-notification 29.44% <ø> (ø)
application-templates-car-recycling 3.12% <ø> (ø)
application-templates-criminal-record 26.63% <ø> (ø)
application-templates-driving-license 18.63% <ø> (-0.08%) ⬇️
application-templates-estate 12.33% <ø> (ø)
application-templates-example-payment 25.41% <ø> (ø)
application-templates-financial-aid 14.34% <ø> (ø)
application-templates-general-petition 23.68% <ø> (ø)
application-templates-health-insurance 26.62% <ø> (ø)
application-templates-inheritance-report 6.45% <ø> (ø)
application-templates-marriage-conditions 15.23% <ø> (ø)
application-templates-mortgage-certificate 43.96% <ø> (ø)
application-templates-parental-leave 30.15% <ø> (ø)
application-types 6.71% <ø> (ø)
application-ui-components 1.28% <ø> (ø)
application-ui-shell 21.29% <ø> (ø)
auth-admin-web ?
auth-api-lib ?
auth-nest-tools ?
auth-shared ?
clients-charge-fjs-v2 24.11% <ø> (ø)
clients-driving-license 40.73% <ø> (ø)
clients-driving-license-book 43.90% <ø> (ø)
clients-financial-statements-inao 49.25% <ø> (ø)
clients-license-client 1.83% <ø> (ø)
clients-middlewares 72.77% <ø> (ø)
clients-regulations 42.71% <ø> (ø)
clients-rsk-company-registry 29.76% <ø> (ø)
clients-rsk-personal-tax-return ?
clients-smartsolutions ?
clients-syslumenn 49.64% <ø> (ø)
cms 0.43% <ø> (ø)
cms-translations 39.04% <ø> (ø)
consultation-portal ?
content-search-index-manager ?
content-search-toolkit ?
dokobit-signing ?
download-service 44.09% <ø> (ø)
file-storage ?
icelandic-names-registry-backend ?
infra-nest-server ?
infra-tracing ?
judicial-system-api 18.30% <ø> (ø)
judicial-system-audit-trail ?
judicial-system-backend 55.24% <ø> (-0.01%) ⬇️
judicial-system-formatters ?
judicial-system-message ?
judicial-system-message-handler ?
judicial-system-scheduler ?
judicial-system-types ?
license-api 42.54% <ø> (-0.08%) ⬇️
localization ?
logging ?
message-queue ?
nest-audit ?
nest-config ?
nest-feature-flags ?
nest-problem ?
nest-sequelize ?
nest-swagger ?
nova-sms ?
react-spa-shared ?
reference-backend ?
regulations ?
residence-history ?
samradsgatt ?
service-portal-core ?
service-portal-health ?
service-portal-information ?
services-auth-admin-api 51.98% <ø> (ø)
services-auth-delegation-api 57.93% <ø> (ø)
services-auth-ids-api 51.88% <ø> (ø)
services-auth-personal-representative 45.55% <ø> (+0.02%) ⬆️
services-auth-personal-representative-public 41.64% <ø> (+0.05%) ⬆️
services-auth-public-api 49.36% <ø> (-0.02%) ⬇️
services-documents ?
services-endorsements-api 55.22% <ø> (ø)
services-search-indexer ?
services-sessions ?
services-university-gateway 48.61% <ø> (+0.08%) ⬆️
services-user-notification 47.07% <ø> (ø)
services-user-profile 62.36% <ø> (+0.07%) ⬆️
shared-mocking ?
shared-pii ?
shared-problem ?
shared-utils ?
skilavottord-ws ?
web 1.83% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 861 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7b20920...45a68f5. Read the comment docs.

@datadog-island-is
Copy link

datadog-island-is bot commented Oct 3, 2024

Datadog Report

Branch report: chore/markdown-linting
Commit report: ee782fa
Test service: web

✅ 0 Failed, 84 Passed, 0 Skipped, 33.65s Total Time
➡️ Test Sessions change in coverage: 1 no change

This state is a temporary state that all new income plans will be created in. It has a short lifespan and is unlisted.

The purpose of this state is to be a guard into the actual income plan. There is an external data step which fetches data from Þjóðskrá and TR. The applicant cannot advance if they have a previous income plan that has been in progress at TR for fewer than 10 days.
This temporary state is where all new income plans are initially created. It is unlisted and has a short lifespan. It acts as a gatekeeper to the actual income plan, fetching data from Þjóðskrá and TR. Applicants cannot proceed if a previous income plan has been in progress at TR for less than 10 days.
Copy link
Member

Choose a reason for hiding this comment

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

A requirement has been added here.

Suggested change
This temporary state is where all new income plans are initially created. It is unlisted and has a short lifespan. It acts as a gatekeeper to the actual income plan, fetching data from Þjóðskrá and TR. Applicants cannot proceed if a previous income plan has been in progress at TR for less than 10 days.
This temporary state is where all new income plans are initially created. It is unlisted and has a short lifespan. It acts as a gatekeeper to the actual income plan, fetching data from Þjóðskrá and TR. Applicants cannot proceed if a previous income plan has been in progress at TR for less than 10 days or if they do not have an active application at TR that requires an income plan.

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.

3 participants