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.

Sign up for GitHub

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

Jump to bottom

Update: Documentation improvements (fixes #57) #58

Merged
merged 16 commits into from
Jun 21, 2024
Merged

Update: Documentation improvements (fixes #57) #58

merged 16 commits into from
Jun 21, 2024

Conversation

swashbuck
Copy link
Contributor

@swashbuck swashbuck commented Jun 5, 2024 •
edited
Loading

Fixes #57

Fix

  • Fix typo in pull_request_template.md

Updates to README.md and schemas

  • Remove required framework version
  • Remove _containerId as this was used for a very specific use case. The property still remains in the code to avoid breaking changes.
  • Removed _onChildren property from documentation. It was already absent from the schemas. The property still remains in the code to avoid breaking changes.
  • Add clarification for using branched blocks that contain only presentation components.
  • Add note about using relative selectors
  • Add note about using multiple branching articles on a page
  • Add note about using Trickle on articles

@swashbuck swashbuck self-assigned this Jun 5, 2024
@swashbuck swashbuck added the documentation Improvements or additions to documentation label Jun 5, 2024
@swashbuck swashbuck marked this pull request as ready for review June 5, 2024 17:33
@swashbuck
Copy link
Contributor Author

swashbuck commented Jun 5, 2024 •
edited
Loading

TBD: I may need to add some clarification on using Trickle with Branching. For instance, should the article's Trickle settings use _onChildren: true, can blocks still override the article's Trickle settings, etc.

oliverfoster
oliverfoster reviewed Jun 5, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
oliverfoster
oliverfoster reviewed Jun 5, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
cahirodoherty-learningpool
cahirodoherty-learningpool approved these changes Jun 7, 2024
View reviewed changes
Copy link
Contributor

Choose a reason for hiding this comment

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

👀

@swashbuck
Copy link
Contributor Author

We're doing some work on #56 , so I will update the documentation depending on the results.

There's also another issue regarding Branching + Trickle, but not sure if it's a core problem yet.

@swashbuck
Copy link
Contributor Author

I've added a note about using Trickle. This should now be ready for final review.

cahirodoherty-learningpool
cahirodoherty-learningpool approved these changes Jun 20, 2024
View reviewed changes
Copy link
Contributor

Choose a reason for hiding this comment

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

👀

joe-allen-89
joe-allen-89 approved these changes Jun 21, 2024
View reviewed changes
Copy link
Contributor

@joe-allen-89 joe-allen-89 left a comment

Choose a reason for hiding this comment

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

👍

@joe-allen-89 joe-allen-89 merged commit 0e7036c into master Jun 21, 2024
@joe-allen-89 joe-allen-89 deleted the issue/57 branch June 21, 2024 15:31
github-actions bot pushed a commit that referenced this pull request Jun 21, 2024
@semantic-release-bot
Chore(release): 1.3.0 [skip ci]
f5ba6ec 
# [1.3.0](v1.2.3...v1.3.0) (2024-06-21)

### Update

* Documentation improvements (fixes #57) (#58) ([0e7036c](0e7036c)), closes [#57](#57) [#58](#58)
@github-actions GitHub Actions
Copy link

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oliverfoster oliverfoster oliverfoster approved these changes

@cahirodoherty-learningpool cahirodoherty-learningpool cahirodoherty-learningpool approved these changes

@joe-allen-89 joe-allen-89 joe-allen-89 approved these changes

Assignees

@swashbuck swashbuck

Labels
documentation Improvements or additions to documentation released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation improvements
4 participants
@swashbuck @oliverfoster @cahirodoherty-learningpool @joe-allen-89