Skip to content

Add project docs - #472

Open
MarcHidalgo5 wants to merge 6 commits into
developfrom
add-docs
Open

Add project docs#472
MarcHidalgo5 wants to merge 6 commits into
developfrom
add-docs

Conversation

@MarcHidalgo5

@MarcHidalgo5 MarcHidalgo5 commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds a project documentation directory for BSWInterfaceKit with package context, module map, platform support notes, feature notes, ADRs, and technical pending items.

Adds repository agent instructions for keeping Docs/ updated when public UI APIs, SwiftUI/UIKit behavior, Android Skip behavior, view-model lifetime, async loading/error handling, navigation, media/social integrations, styling, snapshots, or pending work changes.

@MarcHidalgo5 MarcHidalgo5 changed the title Add project docs and Graphify index Add project docs Jun 23, 2026
@MarcHidalgo5
MarcHidalgo5 marked this pull request as ready for review July 28, 2026 12:56
@michele-theleftbit

Copy link
Copy Markdown
Collaborator

This pull request looks great. Given the current Sources/BSWInterfaceKit structure, what do you think about using this opportunity to reorganize the folders?

SwiftUI is already isolated, while most of the remaining folders (Cells, CollectionViewLayout, ViewControllers, Views, etc.) are UIKit-oriented. Grouping UIKit-specific code under a dedicated UIKit/ directory, while keeping SwiftUI/ separate, would make UIKit dependencies easier to identify and provide a clearer path for progressively deprecating legacy UIKit APIs in a more controlled way.

@MarcHidalgo5

Copy link
Copy Markdown
Collaborator Author

Yes, that makes sense, we can take advantage of this PR so we can keep the Docs synchronized with the new structure

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.

3 participants