Skip to content

Conceptual guides and component architecture fix#2041

Open
Manik-Khajuria-5 wants to merge 5 commits intoplone:6.0from
Manik-Khajuria-5:Conceptual-guides-and-Component-architecture-fix
Open

Conceptual guides and component architecture fix#2041
Manik-Khajuria-5 wants to merge 5 commits intoplone:6.0from
Manik-Khajuria-5:Conceptual-guides-and-Component-architecture-fix

Conversation

@Manik-Khajuria-5
Copy link
Contributor

@Manik-Khajuria-5 Manik-Khajuria-5 commented Jan 24, 2026

Issue number

Description

This pull request improves the Plone Components documentation by clarifying and updating sections related to utilities, adapters, and event subscribers.

The changes focus on making the component architecture easier to understand by:

Explaining how utilities are registered and looked up

Improving adapter registration and usage examples

Updating events and subscribers references

Removing or correcting outdated or unclear documentation links


screenshot-2026-01-24_15-04-04
screenshot-2026-01-24_15-04-23

📚 Documentation preview 📚: https://plone6--2041.org.readthedocs.build/

Copy link
Member

@davisagli davisagli left a comment

Choose a reason for hiding this comment

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

This looks to be off to a good start to me.

@@ -167,40 +167,174 @@ A global utility is constructed when Plone is started and ZCML is read. (needs V
A local component is either a persistent object in the ZODB or constructed when (TODO: When? Traversal time? Lookup time?)
```
Copy link
Member

Choose a reason for hiding this comment

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

Convert the above todo into a normal paragraph:
A global utility is constructed when Plone is started and ZCML is loaded.
A local component is stored as a persistent object in the ZODB.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

okk got it

@Manik-Khajuria-5
Copy link
Contributor Author

@davisagli Thanks for review working on mentioned changes

- Split long sentences into individual lines throughout components.md
- Fix Concepts section (Interface, Adapter, Events, Registries, Lookup)
- Ensure all paragraphs follow one-sentence-per-line style guide
- Resolves formatting issues where text appeared as paragraphs instead of lines
@Manik-Khajuria-5 Manik-Khajuria-5 force-pushed the Conceptual-guides-and-Component-architecture-fix branch from 62004e5 to d5ed69d Compare February 13, 2026 07:35
@Manik-Khajuria-5
Copy link
Contributor Author

@davisagli I have made required changes

Copy link
Member

@davisagli davisagli left a comment

Choose a reason for hiding this comment

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

@stevepiercy I think the information here is accurate.

@Manik-Khajuria-5
Copy link
Contributor Author

@davisagli I have applied the mentioned changes

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

Labels

None yet

Projects

Status: New

Development

Successfully merging this pull request may close these issues.

Conceptual guides > Component architecture needs to be completed

2 participants