Skip to content

@W-21352368 Technical documentation for web applications #1696

Open
lesya7 wants to merge 4 commits intomainfrom
docs/webapplication
Open

@W-21352368 Technical documentation for web applications #1696
lesya7 wants to merge 4 commits intomainfrom
docs/webapplication

Conversation

@lesya7
Copy link
Collaborator

@lesya7 lesya7 commented Mar 3, 2026

What does this PR do?

Adds a webApplicationsSourceAdapter section to HANDBOOK.md for the WebApplication metadata type. Per review, the README Web Applications section and docs/WEBAPPLICATION.md were removed; user-facing docs live in plugin-app-dev.

What issues does this PR fix or reference?

#, @W-21352368@

Functionality Before

No WebApplication documentation in HANDBOOK.

Functionality After

HANDBOOK.md includes a webApplicationsSourceAdapter section that documents the bundle structure, required files, and example layout.

@lesya7 lesya7 requested a review from a team as a code owner March 3, 2026 23:57
@lesya7 lesya7 requested a review from jshackell-sfdc March 3, 2026 23:57
@lesya7 lesya7 force-pushed the docs/webapplication branch from a924f5c to 08367f0 Compare March 3, 2026 23:57
@jshackell-sfdc
Copy link
Contributor

Hi @lesya7,

The WebApplication metadata type is just one of many types that SDR handles, so we keep the docs at a high-level very general.

Here are our requests:

  • Remove the Web Applications section in the README.
  • Also remove the new docs/WEBAPPLICATION.md file.
  • Move relevant info in this PR to the HANDBOOK.MD file in this SDR repo. Take a look at the entry for digitalExperienceAdapter for an example of the type of info that belongs in the handbook.
  • Move any remaining information in this PR that you want to keep to the plugin-app-dev repo. This is "your" repo so you can update docs as you like.

Hope that makes sense!

FYI @soridalac , @iowillhoit

Made-with: Cursor
@jshackell-sfdc
Copy link
Contributor

Small editing tweak. @iowillhoit , do you need to review this update to the SDR handbook too?

iowillhoit and others added 2 commits March 5, 2026 12:47
Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com>
@iowillhoit
Copy link
Contributor

@lesya7 Can you please do a quick update on the PR description to reflect the new state (for future reference)

@lesya7
Copy link
Collaborator Author

lesya7 commented Mar 5, 2026

@iowillhoit Done.

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.

4 participants