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

DXCDT-64 Update docs #67

Merged
merged 7 commits into from
Feb 24, 2022
Merged

DXCDT-64 Update docs #67

merged 7 commits into from
Feb 24, 2022

Conversation

sergiught
Copy link
Contributor

@sergiught sergiught commented Feb 24, 2022

Description

In this PR we are trying to improve our documentation:

  • Ensure all resource have an "import" section that describes how to import each one
  • Fix minor typos
  • Add missing examples
  • Include a Guides Tab that points to the examples

Checklist

Note: Checklist required to be completed before a PR is considered to be reviewable.

Auth0 Code of Conduct

Auth0 General Contribution Guidelines

Changes include test coverage?

  • Yes
  • Not needed

Does the description provide the correct amount of context?

  • Yes, the description provides enough context for the reviewer to understand what these changes accomplish

Have you updated the documentation?

  • Yes, I've updated the appropriate docs
  • Not needed

Is this code ready for production?

  • Yes, all code changes are intentional and no debugging calls are left over

@sergiught sergiught requested a review from a team as a code owner February 24, 2022 15:32
@sergiught sergiught self-assigned this Feb 24, 2022
@@ -0,0 +1,24 @@
; This file is for unifying the coding style for different editors and IDEs.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added this because I was opening the project with 2 different IDEs and they kept messing with each other.

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool, didn't know this was a thing!

Copy link
Contributor

Choose a reason for hiding this comment

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

Wait, are these configurations what's causing the documentation format changes? How do we force that they're being applied without some type of pre-commit or lint checks?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Most modern IDEs will automatically read the .editorconfig and apply the style changes without much user input. https://editorconfig.org/

docs/resources/prompt_custom_text.md Outdated Show resolved Hide resolved
@@ -0,0 +1,24 @@
; This file is for unifying the coding style for different editors and IDEs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Wait, are these configurations what's causing the documentation format changes? How do we force that they're being applied without some type of pre-commit or lint checks?

willvedd
willvedd previously approved these changes Feb 24, 2022
Copy link
Contributor

@willvedd willvedd left a comment

Choose a reason for hiding this comment

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

Still not 100% on board with the line-breaks but something I'm willing to concede on and just observe the pros/cons in due time. I also know this enforcement should work in theory, but still a bit skeptical in practice. But it serves as a good first iteration point that we can improve upon if we see the need.

@sergiught sergiught merged commit dfd4de6 into main Feb 24, 2022
@sergiught sergiught deleted the patch/DXCDT-64-update-docs branch February 24, 2022 18:24
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.

2 participants