fix: charm architecture (#264)

* fix: charm architecture

* chore: update repo contributing guides

* Update docs/explanation/charm-architecture.md

Co-authored-by: Erin Conley <[email protected]>

---------

Co-authored-by: Erin Conley <[email protected]>

Author: yanksyoon

.github/pull_request_template.md

@@ -25,8 +25,8 @@ Applicable spec: <link>
 - [ ] The [charm style guide](https://juju.is/docs/sdk/styleguide) was applied
 - [ ] The [contributing guide](https://github.com/canonical/is-charms-contributing-guide) was applied
 - [ ] The changes are compliant with [ISD054 - Managing Charm Complexity](https://discourse.charmhub.io/t/specification-isd014-managing-charm-complexity/11619)
-- [ ] The documentation is generated using `src-docs`
 - [ ] The documentation for charmhub is updated.
+- [ ] The changelog `docs/changelog.md` is updated.
 - [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `complex`)
 
 <!-- Explanation for any unchecked items above -->

CONTRIBUTING.md

@@ -19,12 +19,3 @@ charmcraft pack
 juju deploy ./wordpress-k8s_ubuntu-22.04-amd64.charm \
     --resource jenkins-image=localhost:32000/wordpress:test
 ```
-
-## Generating src docs for every commit
-
-Run the following command:
-
-```bash
-echo -e "tox -e src-docs\ngit add src-docs\n" > .git/hooks/pre-commit
-chmod +x .git/hooks/pre-commit
-```

docs/changelog.md

@@ -1,6 +1,10 @@
 # Changelog
 
+### 20250-03-11
+
+- docs: fix charm architecture diagram (separate charm containers boundary)
+
 ### 2025-03-10
 
 - Add charm architecture diagram.
-- Add changelog for tracking user-relevant changes.
+- Add changelog for tracking user-relevant changes.

docs/explanation/charm-architecture.md

@@ -18,12 +18,16 @@ C4Context
 title Component diagram for Wordpress Charm
 
 Container_Boundary(wordpress, "WordPress") {
-  Component(pebble, "Pebble", "", "Starts the WordPress server and app")
   Component(apache-server, "Apache server", "", "Serves the WordPress application")
-  Component(charm, "WordPress App", "", "WordPress application")
+  Component(pebble, "Pebble", "", "Starts the WordPress server and app")
 
   Rel(pebble, apache-server, "")
-  Rel(apache-server, charm, "")
+}
+
+Container_Boundary(charm, "WordPress Operator") {
+  Component(charm, "WordPress Operator", "", "WordPress Operator (charm)")
+  
+  Rel(pebble, charm, "")
 }
 ```
 

generate-src-docs.sh

@@ -30,17 +30,6 @@ commands =
     isort {[vars]all_path}
     black {[vars]all_path}
 
-[testenv:src-docs]
-allowlist_externals=sh
-description = Generate documentation for src
-deps =
-    cosl
-    lazydocs
-    -r{toxinidir}/requirements.txt
-commands =
-    ; can't run lazydocs directly due to needing to run it on src/*.py which produces an invocation error in tox
-    sh generate-src-docs.sh
-
 [testenv:lint]
 description = Check code against coding style standards
 deps =