Skip to content

Restructure tree documentation into sub-articles #7695

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
Open
hifi-phil wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Restructure tree documentation into sub-articles #7695

hifi-phil wants to merge 11 commits into from
+718 −216

Conversation

@hifi-phil
Copy link
Contributor

@hifi-phil hifi-phil commented Dec 8, 2025

📋 Description

  • Move tree docs from single file to dedicated tree/ directory
  • Add articles for tree repository, data source, store, navigation
  • Document hideTreeRoot property in menu-item.md
  • Remove duplicated/empty files from old locations

🤖 Generated with Claude Code

📎 Related Issues (if applicable)

✅ Contributor Checklist

I've followed the Umbraco Documentation Style Guide and can confirm that:

  • Code blocks are correctly formatted.
  • Sentences are short and clear (preferably under 25 words).
  • Passive voice and first-person language (“we”, “I”) are avoided.
  • Relevant pages are linked.
  • All links work and point to the correct resources.
  • Screenshots or diagrams are included if useful.
  • Any code examples or instructions have been tested.
  • Typos, broken links, and broken images are fixed.

Product & Version (if relevant)

Deadline (if relevant)

📚 Helpful Resources

@claude
Restructure tree documentation into sub-articles
7e0c597 
- Move tree docs from single file to dedicated tree/ directory
- Add articles for tree repository, data source, store, navigation
- Document hideTreeRoot property in menu-item.md
- Remove duplicated/empty files from old locations

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@hifi-phil hifi-phil marked this pull request as draft December 8, 2025 17:09
Phil Whittaker and others added 7 commits December 8, 2025 17:22
@claude
Clarify API responsibilities and reduce duplication
66e0fa9 
- Add hints to repository, data source, and store docs clarifying
  that only the data source communicates with APIs
- Remove duplicated navigation content from README (now in tree-navigation.md)
- Remove incomplete custom tree item example

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Improve tree navigation link visibility
41b5cef 
- Make navigation link a clear call-to-action instead of buried in warning
- Move Tree Navigation first in SUMMARY.md for better discoverability

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Add tree models documentation
3c810a7 
- Create tree-models.md explaining UmbTreeItemModel and UmbTreeRootModel
- Document all properties with descriptions and usage examples
- Add to SUMMARY.md navigation and README.md implementation guides

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Clarify when to use trees vs menu items
cc7148a 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Simplify tree documentation intro hints
864ea70 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Remove duplicate property table from tree models
89073a2 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Fix tree manifest examples to match working implementation
296a977 
- Include both root and item entity types in treeItem forEntityTypes
- Add missing menuItem properties: name, weight, label, icon, entityType

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@hifi-phil hifi-phil marked this pull request as ready for review December 9, 2025 12:37
@sofietoft
Copy link
Contributor

sofietoft commented Dec 10, 2025

Thanks for the PR @hifi-phil !

Could you please add redirects for the articles you've removed?
Also, there are some vale/styleguide warnings in there. Could you please give those a look as well?
I'll review the PR on Friday at the latest.

Phil Whittaker and others added 3 commits December 10, 2025 09:32
@claude
Minor wording improvements to tree documentation
c33ea46 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Use consistent wording in tree docs
8b8ef1a 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Add redirects for moved tree documentation
2349d66 
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@hifi-phil
Copy link
Contributor Author

hifi-phil commented Dec 10, 2025

Hi @sofietoft

I have fixed the value warnings and added the redirects.
Let me know if you need any other updates.
Phil

@sofietoft
Copy link
Contributor

sofietoft commented Dec 10, 2025

Amazing! Thanks @hifi-phil !
I'll review this on Friday (reach out to Esha, if it needs to be published before then) 🙌

@madsrasmussen
Copy link
Contributor

madsrasmussen commented Dec 11, 2025 •
edited
Loading

Hi @hifi-phil

This is a great foundation to work from. It is good to see that we have included the connection between the Section Sidebar Menu and the Tree.

I think we can simplify the documentation for "Populating Trees" because some of the concepts aren't strictly necessary to make a Tree work.

  • The Tree Store concept is made optional in v17 and will most likely be out-fased at some point.
  • The Tree Data Source is also optional, and it can be left out of the documentation at this point. I can see that I have added a Data Source in the linked example. https://github.com/umbraco/Umbraco-CMS/tree/main/src/Umbraco.Web.UI.Client/examples/tree . I am considering removing that again. It is currently an implementation detail we use in core, but it doesn't bring value because we currently do not have any client-side caching of Trees.

The most important part of a Tree is the Repository because it is referenced in the Tree Manifest. I would make a generic implementation directly in the Repository instead of the Data Source abstraction. Then we are left with only one option to populate the tree.

How does that sound to you?

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

Reviewers

@madsrasmussen madsrasmussen Awaiting requested review from madsrasmussen

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@hifi-phil @sofietoft @madsrasmussen