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

[documentation] Address scaffolding for schema pages #233

Merged
merged 3 commits into from
Jul 17, 2024

Conversation

jenningsanderson
Copy link
Collaborator

@jenningsanderson jenningsanderson commented Jul 8, 2024

Description

Adds addresses to the schema

Reference

#193

Testing

https://dfhx9f55j8eg5.cloudfront.net/pr/233/schema/reference/addresses/address/

Checklist

Checklist of tasks commonly-associated with schema pull requests. Please review the relevant checklists and ensure you do all the tasks that are required for the change you made.

  1. Add relevant examples.
  2. Add relevant counterexamples.
  3. Update any counterexamples that became obsolete. For example, if a counterexample uses property A but is not intended to test property A's validity, and you made a schema change that invalidates property A in that counterexample, fix the counterexample to align it with your schema change.
  4. Update in-schema documentation using plain English written in complete sentences, if an update is required.
  5. Update Docusaurus documentation, if an update is required.
  6. Review change with Overture technical writer to ensure any advanced documentation needs will be taken care of, unless the change is trivial and would not affect the documentation.

Documentation Website

Update the hyperlink below to put the pull request number in.

Docs preview for this PR.

@jenningsanderson
Copy link
Collaborator Author

July 10 Update:

This is a documentation update and we can safely iterate on this into the staging week.

@jenningsanderson jenningsanderson merged commit d356d19 into dev Jul 17, 2024
2 checks passed
jenningsanderson added a commit that referenced this pull request Jul 17, 2024
* update language around subtypes for the divisions theme documentation (#248)

* update language around subtypes for the divisions theme

* add dependency to the list of available subtypes

* [documentation] Address scaffolding for schema pages (#233)

* address scaffolding for schema pages

* Initial schema docs description

* Update address.mdx

---------

Co-authored-by: Jacob Wasserman <[email protected]>

---------

Co-authored-by: Dana Bauer <[email protected]>
Co-authored-by: Jacob Wasserman <[email protected]>
jenningsanderson added a commit that referenced this pull request Jul 17, 2024
* update language around subtypes for the divisions theme documentation (#248)

* update language around subtypes for the divisions theme

* add dependency to the list of available subtypes

* [documentation] Address scaffolding for schema pages (#233)

* address scaffolding for schema pages

* Initial schema docs description

* Update address.mdx

---------

Co-authored-by: Jacob Wasserman <[email protected]>

---------

Co-authored-by: Dana Bauer <[email protected]>
Co-authored-by: Jacob Wasserman <[email protected]>
@jenningsanderson jenningsanderson deleted the address-docs branch August 5, 2024 15:35
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