diff --git a/.github/workflows/claude.yml b/.github/workflows/claude.yml index d526d1e..3b94093 100644 --- a/.github/workflows/claude.yml +++ b/.github/workflows/claude.yml @@ -1,38 +1,19 @@ name: Claude PR Review +# Only triggered by @claude mentions in comments - no automatic reviews +# To request a review, comment "@claude please review this PR" on any PR on: issue_comment: types: [created] pull_request_review_comment: types: [created] - pull_request: - types: [opened, synchronize, ready_for_review, reopened] jobs: - # Respond to @claude mentions in comments claude-respond: if: | (github.event_name == 'issue_comment' || github.event_name == 'pull_request_review_comment') && contains(github.event.comment.body, '@claude') runs-on: ubuntu-latest - permissions: - contents: read - pull-requests: write - issues: write - id-token: write - steps: - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - uses: anthropics/claude-code-action@v1 - with: - claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }} - - # Comprehensive automatic PR review - claude-auto-review: - if: github.event_name == 'pull_request' - runs-on: ubuntu-latest permissions: contents: read pull-requests: write @@ -47,11 +28,10 @@ jobs: with: claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }} track_progress: true - prompt: | - REPO: ${{ github.repository }} - PR NUMBER: ${{ github.event.pull_request.number }} + direct_prompt: | + This is a Sphinx documentation site for the Better Conversations Foundation. - Please perform a comprehensive code review of this pull request. This is a Sphinx documentation site for the Better Conversations Foundation. + If asked to review the PR, use this checklist: ## Review Checklist @@ -90,10 +70,10 @@ jobs: - [ ] Permissions are appropriately scoped - [ ] No security vulnerabilities in workflow - ## Instructions - 1. First, view the PR diff using `gh pr diff ${{ github.event.pull_request.number }}` + ## Instructions for PR reviews + 1. First, view the PR diff using `gh pr diff` 2. Analyze changes against the checklist above - 3. Use inline comments (`mcp__github_inline_comment__create_inline_comment`) for specific issues + 3. Use inline comments for specific issues 4. Post a summary comment with overall findings and the completed checklist 5. Be constructive - suggest improvements, don't just criticise 6. Praise good practices when you see them diff --git a/requirements.txt b/requirements.txt index 5be7707..54249a8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -18,6 +18,7 @@ ablog==0.11.12 sphinx-reredirects==0.1.6 sphinx_design_elements==0.4.0 sphinx-tags +sphinx-multitoc-numbering sphinxcontrib-mermaid graphviz diff --git a/source/_ext/qms_header.py b/source/_ext/qms_header.py index 54779a6..a471d3a 100644 --- a/source/_ext/qms_header.py +++ b/source/_ext/qms_header.py @@ -22,46 +22,30 @@ def normalize_author_name(name: str) -> str: return AUTHOR_NAME_MAP.get(name, name) -def create_header(document_reference, author_datetime, commit_datetime, git_sha, last_author): - """Create the QMS header as a collapsible details element.""" - # Create a collapsible details element with accessibility attributes - details_open = nodes.raw('', '
', format='html') - details_close = nodes.raw('', '
', format='html') +def create_header(document_reference, author_datetime, commit_datetime, git_sha, last_author, include_hr=False): + """Create the QMS header using sphinx-design dropdown HTML structure.""" + # Use the exact same HTML structure as sphinx-design dropdown + # Match the Related Resources format exactly + + # Add hr before the dropdown if the page doesn't have a Related Resources section + hr_html = '
' if include_hr else '' + + dropdown_html = f'''{hr_html}
+ +Document Information
+ +
+
''' - header_list = nodes.bullet_list() - - # Document reference (file path) - header_list += create_item("Reference", document_reference) - - # Last Edited By - header_list += create_item("Last Edited By", last_author) - - # Last Edited (author date - when changes were made) - header_list += create_item("Last Edited", author_datetime) - - # Effective from (commit date - when this version was approved/merged) - header_list += create_item("Effective from", commit_datetime) - - # Git Commit with link to commit on GitHub - commit_link = nodes.reference(refuri=f"{gh_repo_url}/commit/{git_sha}") - commit_link += nodes.Text(git_sha) - header_list += create_item("Git Commit", commit_link) - - # Document status note - deployed = approved - note_para = nodes.paragraph() - note_para += nodes.Text("This is the current approved version. Printed or downloaded copies may be superseded; refer to ") - docs_link = nodes.reference(refuri=docs_site_url) - docs_link += nodes.Text("docs.bettercourses.org") - note_para += docs_link - note_para += nodes.Text(" for the authoritative version.") - header_list += create_item("Note", note_para) - - # Return wrapped in details element container = nodes.container() - container += details_open - container += header_list - container += details_close - + container += nodes.raw('', dropdown_html, format='html') return container @@ -181,12 +165,22 @@ def add_qms_header_to_doctree(app, doctree, docname): else: commit_datetime = "unknown" + # Check if the page has a Related Resources dropdown (preceded by hr) + # If not, we need to add an hr before Document Information + has_related_resources = False + + # Check the full doctree text content for "Related Resources" + doctree_text = doctree.astext() + if 'Related Resources' in doctree_text: + has_related_resources = True + header = create_header( document_reference, author_datetime, commit_datetime, git_sha, - author_name + author_name, + include_hr=not has_related_resources ) # Append the header to the end of the document diff --git a/source/course/05-High-Level-Overview.rst b/source/_ignore/course/05-High-Level-Overview.rst similarity index 100% rename from source/course/05-High-Level-Overview.rst rename to source/_ignore/course/05-High-Level-Overview.rst diff --git a/source/course/10-Module1-State.rst b/source/_ignore/course/10-Module1-State.rst similarity index 100% rename from source/course/10-Module1-State.rst rename to source/_ignore/course/10-Module1-State.rst diff --git a/source/course/20-Module2-Assumptions.rst b/source/_ignore/course/20-Module2-Assumptions.rst similarity index 100% rename from source/course/20-Module2-Assumptions.rst rename to source/_ignore/course/20-Module2-Assumptions.rst diff --git a/source/course/30-Module3-Context.rst b/source/_ignore/course/30-Module3-Context.rst similarity index 100% rename from source/course/30-Module3-Context.rst rename to source/_ignore/course/30-Module3-Context.rst diff --git a/source/course/40-Module4-Listening.rst b/source/_ignore/course/40-Module4-Listening.rst similarity index 100% rename from source/course/40-Module4-Listening.rst rename to source/_ignore/course/40-Module4-Listening.rst diff --git a/source/course/50-Module5-Intentional-Conversations.rst b/source/_ignore/course/50-Module5-Intentional-Conversations.rst similarity index 100% rename from source/course/50-Module5-Intentional-Conversations.rst rename to source/_ignore/course/50-Module5-Intentional-Conversations.rst diff --git a/source/documentation/downloads/history/Genius_Report_Better Conversations.pdf b/source/_ignore/downloads/history/Genius_Report_Better Conversations.pdf similarity index 100% rename from source/documentation/downloads/history/Genius_Report_Better Conversations.pdf rename to source/_ignore/downloads/history/Genius_Report_Better Conversations.pdf diff --git a/source/documentation/public/v1.0/BCO Course Handbook National Grid v1.1.0a.pdf b/source/_ignore/downloads/v1.0/BCO Course Handbook National Grid v1.1.0a.pdf similarity index 100% rename from source/documentation/public/v1.0/BCO Course Handbook National Grid v1.1.0a.pdf rename to source/_ignore/downloads/v1.0/BCO Course Handbook National Grid v1.1.0a.pdf diff --git a/source/documentation/public/v1.0/BCO Course Handbook v1.0.1.pdf b/source/_ignore/downloads/v1.0/BCO Course Handbook v1.0.1.pdf similarity index 100% rename from source/documentation/public/v1.0/BCO Course Handbook v1.0.1.pdf rename to source/_ignore/downloads/v1.0/BCO Course Handbook v1.0.1.pdf diff --git a/source/documentation/public/v1.0/BCO Course Handbook v1.0.pdf b/source/_ignore/downloads/v1.0/BCO Course Handbook v1.0.pdf similarity index 100% rename from source/documentation/public/v1.0/BCO Course Handbook v1.0.pdf rename to source/_ignore/downloads/v1.0/BCO Course Handbook v1.0.pdf diff --git a/source/documentation/public/v1.0/BCO Course Handbook v1.1.0.pdf b/source/_ignore/downloads/v1.0/BCO Course Handbook v1.1.0.pdf similarity index 100% rename from source/documentation/public/v1.0/BCO Course Handbook v1.1.0.pdf rename to source/_ignore/downloads/v1.0/BCO Course Handbook v1.1.0.pdf diff --git a/source/documentation/public/v1.0/BCO Course Handbook v1.1.1.pdf b/source/_ignore/downloads/v1.0/BCO Course Handbook v1.1.1.pdf similarity index 100% rename from source/documentation/public/v1.0/BCO Course Handbook v1.1.1.pdf rename to source/_ignore/downloads/v1.0/BCO Course Handbook v1.1.1.pdf diff --git a/source/documentation/downloads/v2.0/BCF BCO Checklists v2.2.1.docx b/source/_ignore/downloads/v2.0/BCF BCO Checklists v2.2.1.docx similarity index 100% rename from source/documentation/downloads/v2.0/BCF BCO Checklists v2.2.1.docx rename to source/_ignore/downloads/v2.0/BCF BCO Checklists v2.2.1.docx diff --git a/source/documentation/downloads/overview/BCF BCO Course Overview v2.0.pdf b/source/_ignore/downloads/v2.0/BCF BCO Course Overview v2.0.pdf similarity index 100% rename from source/documentation/downloads/overview/BCF BCO Course Overview v2.0.pdf rename to source/_ignore/downloads/v2.0/BCF BCO Course Overview v2.0.pdf diff --git a/source/documentation/downloads/handbook/BC Course Handbook v3.0.0.pdf b/source/_ignore/downloads/v3.0/BC Course Handbook v3.0.0.pdf similarity index 100% rename from source/documentation/downloads/handbook/BC Course Handbook v3.0.0.pdf rename to source/_ignore/downloads/v3.0/BC Course Handbook v3.0.0.pdf diff --git a/source/documentation/downloads/handbook/BC Course Handbook v3.1.0.pdf b/source/_ignore/downloads/v3.0/BC Course Handbook v3.1.0.pdf similarity index 100% rename from source/documentation/downloads/handbook/BC Course Handbook v3.1.0.pdf rename to source/_ignore/downloads/v3.0/BC Course Handbook v3.1.0.pdf diff --git a/source/documentation/downloads/overview/BC Course Overview v3.0.pdf b/source/_ignore/downloads/v3.0/BC Course Overview v3.0.pdf similarity index 100% rename from source/documentation/downloads/overview/BC Course Overview v3.0.pdf rename to source/_ignore/downloads/v3.0/BC Course Overview v3.0.pdf diff --git a/source/course/handbook/BCO_logo.png b/source/_ignore/handbook/BCO_logo.png similarity index 100% rename from source/course/handbook/BCO_logo.png rename to source/_ignore/handbook/BCO_logo.png diff --git a/source/course/handbook/README.md b/source/_ignore/handbook/README.md similarity index 100% rename from source/course/handbook/README.md rename to source/_ignore/handbook/README.md diff --git a/source/course/handbook/assumption.md b/source/_ignore/handbook/assumption.md similarity index 100% rename from source/course/handbook/assumption.md rename to source/_ignore/handbook/assumption.md diff --git a/source/course/handbook/copyright.md b/source/_ignore/handbook/copyright.md similarity index 100% rename from source/course/handbook/copyright.md rename to source/_ignore/handbook/copyright.md diff --git a/source/course/handbook/index.rst b/source/_ignore/handbook/index.rst similarity index 100% rename from source/course/handbook/index.rst rename to source/_ignore/handbook/index.rst diff --git a/source/course/handbook/introduction.md b/source/_ignore/handbook/introduction.md similarity index 100% rename from source/course/handbook/introduction.md rename to source/_ignore/handbook/introduction.md diff --git a/source/course/handbook/lllogo.png b/source/_ignore/handbook/lllogo.png similarity index 100% rename from source/course/handbook/lllogo.png rename to source/_ignore/handbook/lllogo.png diff --git a/source/course/handbook/references.bib b/source/_ignore/handbook/references.bib similarity index 100% rename from source/course/handbook/references.bib rename to source/_ignore/handbook/references.bib diff --git a/source/course/handbook/state.md b/source/_ignore/handbook/state.md similarity index 100% rename from source/course/handbook/state.md rename to source/_ignore/handbook/state.md diff --git a/source/documentation/not_used/delivery-patterns/flight-plan-delivery-pattern.rst b/source/_ignore/patterns/delivery-patterns/flight-plan-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/delivery-patterns/flight-plan-delivery-pattern.rst rename to source/_ignore/patterns/delivery-patterns/flight-plan-delivery-pattern.rst diff --git a/source/documentation/not_used/delivery-patterns/flipchart-delivery-pattern.rst b/source/_ignore/patterns/delivery-patterns/flipchart-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/delivery-patterns/flipchart-delivery-pattern.rst rename to source/_ignore/patterns/delivery-patterns/flipchart-delivery-pattern.rst diff --git a/source/documentation/not_used/delivery-patterns/index.rst b/source/_ignore/patterns/delivery-patterns/index.rst similarity index 100% rename from source/documentation/not_used/delivery-patterns/index.rst rename to source/_ignore/patterns/delivery-patterns/index.rst diff --git a/source/documentation/not_used/delivery-patterns/observations-delivery-pattern.rst b/source/_ignore/patterns/delivery-patterns/observations-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/delivery-patterns/observations-delivery-pattern.rst rename to source/_ignore/patterns/delivery-patterns/observations-delivery-pattern.rst diff --git a/source/documentation/not_used/delivery-patterns/roles-delivery-pattern.rst b/source/_ignore/patterns/delivery-patterns/roles-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/delivery-patterns/roles-delivery-pattern.rst rename to source/_ignore/patterns/delivery-patterns/roles-delivery-pattern.rst diff --git a/source/documentation/not_used/delivery-patterns/writing-delivery-pattern.rst b/source/_ignore/patterns/delivery-patterns/writing-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/delivery-patterns/writing-delivery-pattern.rst rename to source/_ignore/patterns/delivery-patterns/writing-delivery-pattern.rst diff --git a/source/documentation/not_used/design-patterns/continuous-improvement-pattern.rst b/source/_ignore/patterns/design-patterns/continuous-improvement-pattern.rst similarity index 100% rename from source/documentation/not_used/design-patterns/continuous-improvement-pattern.rst rename to source/_ignore/patterns/design-patterns/continuous-improvement-pattern.rst diff --git a/source/documentation/not_used/design-patterns/flight-plan-design-pattern.rst b/source/_ignore/patterns/design-patterns/flight-plan-design-pattern.rst similarity index 100% rename from source/documentation/not_used/design-patterns/flight-plan-design-pattern.rst rename to source/_ignore/patterns/design-patterns/flight-plan-design-pattern.rst diff --git a/source/documentation/not_used/design-patterns/flipchart-design-pattern.rst b/source/_ignore/patterns/design-patterns/flipchart-design-pattern.rst similarity index 100% rename from source/documentation/not_used/design-patterns/flipchart-design-pattern.rst rename to source/_ignore/patterns/design-patterns/flipchart-design-pattern.rst diff --git a/source/documentation/not_used/design-patterns/index.rst b/source/_ignore/patterns/design-patterns/index.rst similarity index 100% rename from source/documentation/not_used/design-patterns/index.rst rename to source/_ignore/patterns/design-patterns/index.rst diff --git a/source/documentation/not_used/design-patterns/observations-design-pattern.rst b/source/_ignore/patterns/design-patterns/observations-design-pattern.rst similarity index 100% rename from source/documentation/not_used/design-patterns/observations-design-pattern.rst rename to source/_ignore/patterns/design-patterns/observations-design-pattern.rst diff --git a/source/documentation/not_used/design-patterns/roles-design-pattern.rst b/source/_ignore/patterns/design-patterns/roles-design-pattern.rst similarity index 100% rename from source/documentation/not_used/design-patterns/roles-design-pattern.rst rename to source/_ignore/patterns/design-patterns/roles-design-pattern.rst diff --git a/source/documentation/not_used/design-patterns/writing-design-pattern.rst b/source/_ignore/patterns/design-patterns/writing-design-pattern.rst similarity index 100% rename from source/documentation/not_used/design-patterns/writing-design-pattern.rst rename to source/_ignore/patterns/design-patterns/writing-design-pattern.rst diff --git a/source/documentation/not_used/to-develop/Delivery-Team.rst b/source/_ignore/patterns/to-develop/Delivery-Team.rst similarity index 100% rename from source/documentation/not_used/to-develop/Delivery-Team.rst rename to source/_ignore/patterns/to-develop/Delivery-Team.rst diff --git a/source/documentation/not_used/to-develop/Timing.rst b/source/_ignore/patterns/to-develop/Timing.rst similarity index 100% rename from source/documentation/not_used/to-develop/Timing.rst rename to source/_ignore/patterns/to-develop/Timing.rst diff --git a/source/documentation/not_used/to-develop/accessibilty-design-pattern.rst b/source/_ignore/patterns/to-develop/accessibilty-design-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/accessibilty-design-pattern.rst rename to source/_ignore/patterns/to-develop/accessibilty-design-pattern.rst diff --git a/source/documentation/not_used/to-develop/breakout-design-pattern.rst b/source/_ignore/patterns/to-develop/breakout-design-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/breakout-design-pattern.rst rename to source/_ignore/patterns/to-develop/breakout-design-pattern.rst diff --git a/source/documentation/not_used/to-develop/breakout-rooms-delivery-pattern.rst b/source/_ignore/patterns/to-develop/breakout-rooms-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/breakout-rooms-delivery-pattern.rst rename to source/_ignore/patterns/to-develop/breakout-rooms-delivery-pattern.rst diff --git a/source/documentation/not_used/to-develop/breakouts-delivery-pattern.rst b/source/_ignore/patterns/to-develop/breakouts-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/breakouts-delivery-pattern.rst rename to source/_ignore/patterns/to-develop/breakouts-delivery-pattern.rst diff --git a/source/documentation/not_used/to-develop/breaks-delivery-pattern.rst b/source/_ignore/patterns/to-develop/breaks-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/breaks-delivery-pattern.rst rename to source/_ignore/patterns/to-develop/breaks-delivery-pattern.rst diff --git a/source/documentation/not_used/to-develop/chat-delivery-pattern.rst b/source/_ignore/patterns/to-develop/chat-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/chat-delivery-pattern.rst rename to source/_ignore/patterns/to-develop/chat-delivery-pattern.rst diff --git a/source/documentation/not_used/to-develop/checklist-design-pattern.rst b/source/_ignore/patterns/to-develop/checklist-design-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/checklist-design-pattern.rst rename to source/_ignore/patterns/to-develop/checklist-design-pattern.rst diff --git a/source/documentation/not_used/to-develop/demo-delivery-pattern.rst b/source/_ignore/patterns/to-develop/demo-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/demo-delivery-pattern.rst rename to source/_ignore/patterns/to-develop/demo-delivery-pattern.rst diff --git a/source/documentation/not_used/to-develop/discussions-delivery-pattern.rst b/source/_ignore/patterns/to-develop/discussions-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/discussions-delivery-pattern.rst rename to source/_ignore/patterns/to-develop/discussions-delivery-pattern.rst diff --git a/source/documentation/not_used/to-develop/early-engagement-delivery-pattern.rst b/source/_ignore/patterns/to-develop/early-engagement-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/early-engagement-delivery-pattern.rst rename to source/_ignore/patterns/to-develop/early-engagement-delivery-pattern.rst diff --git a/source/documentation/not_used/to-develop/exercises-design-pattern.rst b/source/_ignore/patterns/to-develop/exercises-design-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/exercises-design-pattern.rst rename to source/_ignore/patterns/to-develop/exercises-design-pattern.rst diff --git a/source/documentation/not_used/to-develop/facilitator-guide.rst b/source/_ignore/patterns/to-develop/facilitator-guide.rst similarity index 100% rename from source/documentation/not_used/to-develop/facilitator-guide.rst rename to source/_ignore/patterns/to-develop/facilitator-guide.rst diff --git a/source/documentation/not_used/to-develop/facilitator-state-delivery-pattern.rst b/source/_ignore/patterns/to-develop/facilitator-state-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/facilitator-state-delivery-pattern.rst rename to source/_ignore/patterns/to-develop/facilitator-state-delivery-pattern.rst diff --git a/source/documentation/not_used/to-develop/flight-plan-data.rst b/source/_ignore/patterns/to-develop/flight-plan-data.rst similarity index 100% rename from source/documentation/not_used/to-develop/flight-plan-data.rst rename to source/_ignore/patterns/to-develop/flight-plan-data.rst diff --git a/source/documentation/not_used/to-develop/flight-plan-quality.rst b/source/_ignore/patterns/to-develop/flight-plan-quality.rst similarity index 100% rename from source/documentation/not_used/to-develop/flight-plan-quality.rst rename to source/_ignore/patterns/to-develop/flight-plan-quality.rst diff --git a/source/documentation/not_used/to-develop/group-size-design-pattern.rst b/source/_ignore/patterns/to-develop/group-size-design-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/group-size-design-pattern.rst rename to source/_ignore/patterns/to-develop/group-size-design-pattern.rst diff --git a/source/documentation/not_used/to-develop/handing-over-for-support-guidance.rst b/source/_ignore/patterns/to-develop/handing-over-for-support-guidance.rst similarity index 100% rename from source/documentation/not_used/to-develop/handing-over-for-support-guidance.rst rename to source/_ignore/patterns/to-develop/handing-over-for-support-guidance.rst diff --git a/source/documentation/not_used/to-develop/latecomers-delivery-pattern.rst b/source/_ignore/patterns/to-develop/latecomers-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/latecomers-delivery-pattern.rst rename to source/_ignore/patterns/to-develop/latecomers-delivery-pattern.rst diff --git a/source/documentation/not_used/to-develop/producer-guide.rst b/source/_ignore/patterns/to-develop/producer-guide.rst similarity index 100% rename from source/documentation/not_used/to-develop/producer-guide.rst rename to source/_ignore/patterns/to-develop/producer-guide.rst diff --git a/source/documentation/not_used/to-develop/single-attendee-delivery-pattern.rst b/source/_ignore/patterns/to-develop/single-attendee-delivery-pattern.rst similarity index 100% rename from source/documentation/not_used/to-develop/single-attendee-delivery-pattern.rst rename to source/_ignore/patterns/to-develop/single-attendee-delivery-pattern.rst diff --git a/source/documentation/quick-reference.md b/source/_ignore/quick-reference.md similarity index 100% rename from source/documentation/quick-reference.md rename to source/_ignore/quick-reference.md diff --git a/source/documentation/tips/Google-Calendar.rst b/source/_ignore/tips/Google-Calendar.rst similarity index 100% rename from source/documentation/tips/Google-Calendar.rst rename to source/_ignore/tips/Google-Calendar.rst diff --git a/source/documentation/tips/Recording.rst b/source/_ignore/tips/Recording.rst similarity index 100% rename from source/documentation/tips/Recording.rst rename to source/_ignore/tips/Recording.rst diff --git a/source/documentation/tips/Zoom-Captions.rst b/source/_ignore/tips/Zoom-Captions.rst similarity index 100% rename from source/documentation/tips/Zoom-Captions.rst rename to source/_ignore/tips/Zoom-Captions.rst diff --git a/source/documentation/tips/images/google-meeting-permissions-after.png b/source/_ignore/tips/images/google-meeting-permissions-after.png similarity index 100% rename from source/documentation/tips/images/google-meeting-permissions-after.png rename to source/_ignore/tips/images/google-meeting-permissions-after.png diff --git a/source/documentation/tips/images/google-meeting-permissions-before.png b/source/_ignore/tips/images/google-meeting-permissions-before.png similarity index 100% rename from source/documentation/tips/images/google-meeting-permissions-before.png rename to source/_ignore/tips/images/google-meeting-permissions-before.png diff --git a/source/documentation/tips/images/google-meeting.png b/source/_ignore/tips/images/google-meeting.png similarity index 100% rename from source/documentation/tips/images/google-meeting.png rename to source/_ignore/tips/images/google-meeting.png diff --git a/source/documentation/tips/index.rst b/source/_ignore/tips/index.rst similarity index 100% rename from source/documentation/tips/index.rst rename to source/_ignore/tips/index.rst diff --git a/source/_static/css/custom.css b/source/_static/css/custom.css index 88bdd17..30c3bf4 100644 --- a/source/_static/css/custom.css +++ b/source/_static/css/custom.css @@ -464,7 +464,6 @@ section#documentation-resources > h1 { } section#documentation-resources > p:first-of-type { - font-size: 0.95rem; line-height: 1.6; color: #4b5563; margin-bottom: 0.5rem; @@ -473,7 +472,6 @@ section#documentation-resources > p:first-of-type { /* Link to main BCF site */ section#documentation-resources > p:nth-of-type(2) { margin-bottom: 1rem; - font-size: 0.85rem; } /* Quick Links section heading */ @@ -482,7 +480,6 @@ section#quick-links { } section#quick-links > h2 { - font-size: 1.3rem; margin-bottom: 1rem; color: #374151; } @@ -528,12 +525,18 @@ section#documentation-resources { /* Dropdown container */ details.sd-dropdown { border: none !important; + border-left: none !important; border-radius: 0.5rem !important; margin-bottom: 0.5rem !important; overflow: hidden; box-shadow: none !important; } +/* Remove left border from summary */ +details.sd-dropdown > summary { + border-left: none !important; +} + /* Dropdown summary/header */ details.sd-dropdown > summary { background-color: #f3f4f6 !important; @@ -593,4 +596,30 @@ details.sd-dropdown > summary .sd-summary-icon { details.sd-dropdown > summary:hover .sd-summary-icon, details.sd-dropdown[open] > summary .sd-summary-icon { color: white !important; +} + +/* ============================================ + Footer Section - Related Resources & Document Information + ============================================ */ + +/* Horizontal rule before footer dropdowns - consistent spacing */ +hr + details.sd-dropdown { + margin-top: 1.5rem !important; +} + +/* The QMS header divider hr styling */ +hr.qms-header-divider { + margin-top: 2rem !important; + margin-bottom: 0 !important; +} + +/* When QMS header follows an hr directly (no Related Resources) */ +hr.qms-header-divider + details.sd-dropdown.qms-header { + margin-top: 1.5rem !important; +} + +/* Document Information dropdown - minimal gap after Related Resources */ +details.sd-dropdown.qms-header { + margin-top: 0.5rem !important; + margin-bottom: 0 !important; } \ No newline at end of file diff --git a/source/conf.py b/source/conf.py index 4a93778..e3d265d 100644 --- a/source/conf.py +++ b/source/conf.py @@ -29,9 +29,9 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'myst_parser', - 'sphinx.ext.todo', - 'sphinx_last_updated_by_git', + 'myst_parser', + 'sphinx.ext.todo', + 'sphinx_last_updated_by_git', 'sphinx.ext.intersphinx', # 'ablog', - note we conditionally add this in the following block # 'sphinx_external_toc', @@ -40,6 +40,7 @@ "sphinx_design", "sphinx_design_elements", "sphinx_tags", + "sphinx_multitoc_numbering", "sphinxcontrib.mermaid", "sphinx.ext.graphviz", "qms_header", @@ -71,7 +72,7 @@ # Ensure that PDFs are copied to the site by specifying the directories containing PDFs in the html_extra_path. # This will copy the contents of the 'downloads' directory to the root of the build. -html_extra_path = ['robots.txt'] +html_extra_path = ['robots.txt', 'downloads'] # Note everything in this folder will be copied to the root of the build @@ -206,11 +207,11 @@ rst_prolog = """ -.. _current-overview: /downloads/BC%20Course%20Overview.pdf +.. _current-overview: /BC%20Course%20Overview.pdf -.. _current-handbook: /downloads/BC%20Course%20Handbook.pdf +.. _current-handbook: /BC%20Course%20Handbook.pdf -.. _current-flipcharts: /downloads/BC%20Course%20Flipcharts.pdf +.. _current-flipcharts: /BC%20Course%20Flipcharts.pdf .. raw:: html @@ -235,7 +236,7 @@ redirects = { # Old docs site paths → new locations - "documentation/200-the_course.index.html": "/course/index.html", + "documentation/200-the_course.index.html": "documentation/course/index.html", "documentation/800-resources/email-templates.html": "/documentation/course-materials/email_templates.html", # Old blog paths → BCF main site blog "2023/05/02/modelling-sales.html": "https://betterconversations.foundation/blog/modelling-sales", diff --git a/source/course/60-Handbook-and-emails.rst b/source/course/60-Handbook-and-emails.rst deleted file mode 100644 index 6da72f3..0000000 --- a/source/course/60-Handbook-and-emails.rst +++ /dev/null @@ -1,30 +0,0 @@ -=================== -Handbook and Emails -=================== - - -.. todo:: - - - remove duplicate content from here and download page - ---------------- -Course Handbook ---------------- - -We have prepared a handbook for participants which you can download -as a PDF `here `_ -It contains information about the course and also the material that's -taught. - - ---------------- -Email Templates ---------------- - -We have prepared a set of email templates that you can use to invite -participants and followup after each module `here `_ - -We recognise that people want to customise the handbook, with their own -branding, contact information, etc. People have also taken individual sections -and e.g. on State and used them in other circumstances like coaching. Please -get in touch if you would like to do this. diff --git a/source/work-with-us/behind-the-scenes/ai.rst b/source/documentation/behind-the-scenes/ai.rst similarity index 100% rename from source/work-with-us/behind-the-scenes/ai.rst rename to source/documentation/behind-the-scenes/ai.rst diff --git a/source/work-with-us/behind-the-scenes/index.rst b/source/documentation/behind-the-scenes/index.rst similarity index 92% rename from source/work-with-us/behind-the-scenes/index.rst rename to source/documentation/behind-the-scenes/index.rst index 143417e..59c567a 100644 --- a/source/work-with-us/behind-the-scenes/index.rst +++ b/source/documentation/behind-the-scenes/index.rst @@ -10,3 +10,4 @@ Fancy a look behind the scenes? Here's how we work. technical-stack ai + stable-links diff --git a/source/documentation/stable-links.rst b/source/documentation/behind-the-scenes/stable-links.rst similarity index 100% rename from source/documentation/stable-links.rst rename to source/documentation/behind-the-scenes/stable-links.rst diff --git a/source/work-with-us/behind-the-scenes/technical-stack.rst b/source/documentation/behind-the-scenes/technical-stack.rst similarity index 100% rename from source/work-with-us/behind-the-scenes/technical-stack.rst rename to source/documentation/behind-the-scenes/technical-stack.rst diff --git a/source/work-with-us/community/coc-reporting.rst b/source/documentation/community/coc-reporting.rst similarity index 100% rename from source/work-with-us/community/coc-reporting.rst rename to source/documentation/community/coc-reporting.rst diff --git a/source/work-with-us/community/coc.rst b/source/documentation/community/coc.rst similarity index 98% rename from source/work-with-us/community/coc.rst rename to source/documentation/community/coc.rst index e52dd84..d94abbf 100644 --- a/source/work-with-us/community/coc.rst +++ b/source/documentation/community/coc.rst @@ -10,7 +10,7 @@ community. Following a `consultation with the community `_, the following Code of Conduct was adopted by the Board of Directors of the Foundation at `their meeting of 27th February 2025 -`_. +/documentation/governance/board/minutes-2025-02-27.html>`_. The Better Conversations team and community is made up of a mixture of @@ -37,7 +37,7 @@ spaces may affect a person's ability to participate within them. If you believe someone is violating the code of conduct, we ask that you report it by emailing `contacting us here `_. For more details please see our `Reporting Guidelines -`_. +/documentation/community/coc-reporting.html>`_. * Be friendly and patient. diff --git a/source/work-with-us/improvements-and-suggestions.rst b/source/documentation/community/improvements-and-suggestions.rst similarity index 100% rename from source/work-with-us/improvements-and-suggestions.rst rename to source/documentation/community/improvements-and-suggestions.rst diff --git a/source/work-with-us/community/index.rst b/source/documentation/community/index.rst similarity index 51% rename from source/work-with-us/community/index.rst rename to source/documentation/community/index.rst index 4628803..0b017cc 100644 --- a/source/work-with-us/community/index.rst +++ b/source/documentation/community/index.rst @@ -3,7 +3,7 @@ The Better Conversations Community ================================== You might think Better Conversations is a course, perhaps even a set of -flight plans. In fact, all of that comes from our community. +flight plans. In fact, all of that comes from our community. The Foundation is a not-for-profit organisation that exists to support the community. @@ -16,10 +16,27 @@ subject to the Foundation's Employee Handbook and disciplinary process which may be more stringent than the Code of Conduct, have different processes, and have more severe penalties. +**What's available:** + +- :doc:`coc` - our code of conduct +- :doc:`coc-reporting` - how to report issues +- :doc:`improvements-and-suggestions` - how to contribute improvements + +---- + +.. dropdown:: Related Resources + :animate: fade-in + + - **Partnership**: :doc:`/documentation/work-with-us/index` - working with the Foundation + - **Governance**: :doc:`/documentation/governance/index` - structure, policies, and board + - **Using the course**: :doc:`/documentation/using-the-course/index` - practical usage details + .. toctree:: :maxdepth: 2 - :caption: Contents: + :caption: Contents + :hidden: - coc + coc coc-reporting + improvements-and-suggestions \ No newline at end of file diff --git a/source/documentation/course-design/index.rst b/source/documentation/course-design/index.rst index 434e753..8de7b5b 100644 --- a/source/documentation/course-design/index.rst +++ b/source/documentation/course-design/index.rst @@ -1,138 +1,79 @@ Course Design ============= -Design is a term that can mean different things, such as: - -- The **purpose, intention, or goal** of something -- The **creation, planning, or arrangement** of an object, a process, or a -system, according to a specific purpose, function, or context. -- The **plan behind** an action, fact, or object. -- A **pattern** or a **style** of something. - -Design is about finding better ways to do things. It's both a science and an -art, a blend of logic, analysis, and utility, as well as intuition, -imagination, and creativity. - - -Design principles guide our decisions -------------------------------------- - -We've also developed a set of design principles that guide our decisions. These -principles are based on our understanding of how adults learn, and on our -experience of designing and delivering other courses. The principles are: - -**Separate information from learning**: We've designed the course to separate -information from learning, so that participants can learn by doing, and by -reflecting on what they've done. We've designed the course to be delivered in a -way that encourages participants to engage with the material, with each other, -and with the facilitator. - -**The magic happens in the conversations**: We've designed the course to focus -on the conversations that participants have with each other, and with the -facilitator. We've designed the course to be delivered in a way that encourages -participants to engage with the material, with each other, and with the -facilitator. - -**Keep it simple**: We've designed the course to explain the models and -concepts in 5 minutes or less, so that participants can understand and remember -what they've learned. - -**Think systemically**: We've always tried to think a few steps ahead, to -dare to dream big and to think about our overall mission. Some of the decisions -we've may seem odd or unnecessary at first, but they are all part of a -longer-term plan. You can always ask us if you're not sure why we've done -something a particular way! - -**Always be learning**: We have a tight learning loop, where we gather -feedback, reflect on it, and make changes. We're always looking for ways to -improve the course, and we're always learning from our experiences. - -**Know when to be systematic** Whilst learning and adaptation requires an -ability to hold many things in play at once, there are times when it is helpful -to standardise and introduce consistency. We've built systems, processes and -tools that help us to deliver the course in a reliable and scalable way. - -Design constraints +This section explains why Better Conversations is designed the way it is. Understanding the design philosophy helps you deliver more effectively and adapt the course thoughtfully. + +The course has been through hundreds of hours of design, development, and delivery. Every element reflects our understanding of how adults learn best—through practice, reflection, and connection with others. When something seems unusual, there's usually a reason. We encourage you to ask. + +---- + +Design Principles +----------------- + +These principles guide every decision we make about the course. + +.. grid:: 2 2 3 3 + :gutter: 3 + + .. grid-item-card:: :fas:`comments` The magic happens in conversations + + Practice time matters more than teaching time. We minimise explanation and maximise participant interaction. + + .. grid-item-card:: :fas:`seedling` Separate information from learning + + The handbook contains the information. Sessions focus on doing and reflecting. + + .. grid-item-card:: :fas:`compress` Keep it simple + + Every model can be explained in under 5 minutes. If it takes longer, we simplify it. + + .. grid-item-card:: :fas:`project-diagram` Think systemically + + Decisions connect to our broader mission. Ask us if something seems odd - there's usually a reason. + + .. grid-item-card:: :fas:`sync` Always be improving + + We gather feedback, reflect, and iterate. The course evolves based on what we learn from every delivery. + + .. grid-item-card:: :fas:`clipboard-check` Standardise where useful + + Checklists, flight plans, and consistent processes enable reliable delivery at scale. + +---- + +Design Constraints ------------------ -We've decided to work within certain constraints. It may seem counterintuitive, -but these constraints actually help us to be more creative and to make better -decisions. For example: - -**We deliver the course online**: This means that we can reach a global -audience, and also reach people who might be working remotely or who might not -be able to travel to a training course. - -**We deliver the course in 6 modules**: This means that we have to be -selective about what we include in the course. It also means there are -opportunities for people who want to go deeper to do so, by adding extra modules -that are tailored to their audience. - -**Each module is delivered in one hour**: This means that we have to be -concise and focused in the way we deliver the course. It's led to a repeatable -pattern of delivery that we can rely on. - -**We limit 'teaching' time**: This means that we have to be clear in the way -we explain the models and concepts, remove any unnecessary detail, and simplify -the material as much as possible (which is harder than it looks!). It also -means we maximise the time for participants to practice and reflect. - - -Design features ---------------- - -We've developed this course over hundreds of hours of design, development, and -delivery. We've iterated and improved it based on feedback from participants -and facilitators. We've also drawn on our experience of designing and -delivering other courses, and our understanding of how adults learn. The output -of all that work is a course that is designed to be: - -**Accessible and flexible**: We want a wide range of people to enjoy this -course and for it to be useful in different contexts. We've designed it to be -delivered online, in English, and in a modular format. We've also designed it -to be flexible, so that you can adapt it to your own needs, for example by -using different tools, delivering it in another language, or delivering it in a -different way. We encourage you to adapt the course to your own needs, and to -share your experiences with us. - -**Interactive and experiential**: Participants can learn by doing, and by -reflecting on what they've done. We've designed it to be delivered in a way -that encourages participants to engage with the material, with each other, and -with the facilitator. - -**Consistent and scalable**: Colleagues who do the course at different times -will learn the same things. We've designed it to be scalable, so that it can be -delivered to diverse participants across cultures and contexts. - -**Robust and reliable**: It's important to use that the material worls with -diverse participants across cultures and contexts. We've designed it to support -employees with any behaviour change that is needed for better conversations, -and to be relevant and easy to apply in business situations. - -**Relevant and easy to apply**: We want the content of the course to be -relevant and easy to apply in business situations. We've designed it to support -employees with any behaviour change that is needed for better conversations, -and to be relevant and easy to apply in business situations. - -**Engaging and Actionable**: We strive to be clear, concise and for the skills -to be actionable, so that participants are motivated to use what they've -learned immediately. We know people apply new skills when they are relevant to -their circumstances. - -.. todo:: - - Add: - systemic-outlook - systematic-approach - information-learning - simplicity - magic-conversations - - - - This section has been compiled with the help of CoPilot so needs a good edit - - Make the link to assumptions and context; design is all about these. - - Review and include more design principles - - Would be nice to explain the design principles then link to the guidance e.g. seperate information from learning and put it in handbook - - Features and benefits - are we going to list them here? - - Add link to handbook? - - do we need separate sections? \ No newline at end of file +It may seem counterintuitive, but constraints drive creativity. We've chosen to work within these boundaries deliberately: + +| :fas:`globe` **Online delivery** - We deliver the course online. This means we can reach a global audience, including people working remotely or those who can't travel to training. The course also works well in person. +| +| :fas:`cubes-stacked` **Six modules** - We deliver the course in 6 modules. This forces us to be selective about what we include. It also creates opportunities for people who want to go deeper—you can add extra modules tailored to your audience. +| +| :fas:`clock` **One hour per module** - Each module is delivered in one hour. This means we have to be concise and focused, which has led to a repeatable pattern of delivery we can rely on. +| +| :fas:`hourglass-half` **Limited teaching time** - We limit how much time is spent explaining. This forces us to be clear, remove unnecessary detail, and simplify as much as possible (which is harder than it looks!). It also maximises time for participants to practice and reflect. + +---- + +What This Creates +----------------- + +The result is a course designed to be: + +| **Accessible and flexible** - Works across contexts, languages, and delivery styles. Adapt it to your needs - different tools, languages, or formats. We encourage you to make it your own and share what you learn. +| +| **Interactive and experiential** - Participants learn by doing and reflecting, not just listening. The design encourages engagement with the material, with each other, and with you. +| +| **Consistent and scalable** - Everyone learns the same core content, whether they're in London or Lagos. The course works with diverse participants across cultures and contexts. +| +| **Actionable** - Skills apply immediately to real conversations. We've designed it so participants are motivated to use what they've learned straight away. + +---- + +.. dropdown:: Related Resources + :animate: fade-in + + - **Review the course**: :doc:`/documentation/course/index` - revisit modules and structure + - **Get practical**: :doc:`/documentation/guides/index` - delivery guidance + - **See what works**: :doc:`/documentation/patterns/index` - proven techniques \ No newline at end of file diff --git a/source/documentation/course-improvement/index.rst b/source/documentation/course-improvement/index.rst deleted file mode 100644 index 3df2918..0000000 --- a/source/documentation/course-improvement/index.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. _course-improvement: - -================== -Course Improvement -================== - -What works reliably (patterns) -============================== - -Through thousands of hours designing and delivering Better Conversations, we've discovered what works reliably and what needs adjusting for context. We're sharing our experience to help you deliver the course effectively while honoring your own style. - -When we've tested something across many sessions and found it consistently effective, we document it as a "pattern" - a term borrowed from software development. These patterns represent proven approaches to common situations in Better Conversations delivery. - -Our patterns aren't rules or requirements. They're reliable solutions we've refined through experience. We encourage you to try them as described first - they work because specific elements combine in specific ways. Once you understand why they work, you'll be better equipped to adapt them to your context. - -Where style and preference matter (guidance) -============================================ - -Some aspects of delivery are more flexible, influenced by facilitator style, group dynamics, or context. We document these as "guidance" notes - different approaches we've seen work well, each with its own benefits. - -Guidance acknowledges that skilled delivery teams might choose different paths to the same destination. We share multiple approaches so you can find what aligns with your natural style while serving your participants effectively. - -Why we share this information -============================= - -Transparency matters to us. By documenting both our reliable patterns and flexible guidance, we: - -- Help you understand the thinking behind course design decisions -- Support your development as a facilitator and/or producer -- Encourage informed adaptation rather than guesswork -- Build a community of practice where we all learn together - -Your experience matters too! -============================ - -These patterns and guidance aren't set in stone. They evolve as we learn. If you discover variations that work well, or if something doesn't work in your context, we want to know! Your experience contributes to the collective learning that makes Better Conversations better for everyone. - -Whether you're delivering our course or designing your own, these patterns provide tested starting points. Use what serves you, adapt what needs adapting, and please share what you learn with us. You can do this by `contacting us directly `_ or by `posting in our community `_ (if you have already signed up with us).. \ No newline at end of file diff --git a/source/documentation/course-materials/flipcharts.rst b/source/documentation/course-materials/flipcharts.rst index acaf984..c99a993 100644 --- a/source/documentation/course-materials/flipcharts.rst +++ b/source/documentation/course-materials/flipcharts.rst @@ -10,4 +10,4 @@ If you are running a course for the Foundation you'll be using the latest versio The latest version of the example flipcharts are available as a pdf download `here `_. -Please get in touch with us if you need a copy of the flipcharts in another format. +Please `get in touch with us `_ if you need a copy of the flipcharts in another format. diff --git a/source/documentation/course-materials/handbook.rst b/source/documentation/course-materials/handbook.rst index bde7617..45de4d0 100644 --- a/source/documentation/course-materials/handbook.rst +++ b/source/documentation/course-materials/handbook.rst @@ -7,7 +7,7 @@ as a PDF `here `_. It contains information about the course and also the material that's taught. -If you would like this branded with your logos etc. do get in touch. +If you would like this branded with your logos etc. do `get in touch `_. Similarly if you want just a section of this with a specific model we can do this for you. diff --git a/source/documentation/course-materials/index.rst b/source/documentation/course-materials/index.rst index c75d680..f5dd102 100644 --- a/source/documentation/course-materials/index.rst +++ b/source/documentation/course-materials/index.rst @@ -1,33 +1,29 @@ .. _course-materials: + ================ Course Materials ================ -.. These are generally documents and other artefacts. They can be considered as structural design patterns. - -This section contains the course materials for you to download. -These are the documents and communications that you will need to run the course. -They are generally in the form of PDFs, Word and PowerPoint documents. - -There are public URLs which allow people to download materials without having to log in. -These are not versioned, you'll just get the most recent version. +This section contains the documents and resources you need to deliver Better Conversations. Download what you need in PDF, Word, or PowerPoint format. -- Course Handbook can be referred to as https://betterconversations.foundation/l/handbook +**What's available:** -These stable links will need authentication, but will always point to the most recent version. +- :doc:`course_overview` - comprehensive guide to the course structure and design (31 pages) +- :doc:`flight_plans` - detailed session-by-session delivery scripts +- :doc:`flipcharts` - visual aids and agenda templates +- :doc:`handbook` - participant handbook with course content +- :doc:`email_templates` - invitation and follow-up email wording -- Flight plans https://betterconversations.foundation/l/masters -- Course overview https://betterconversations.foundation/l/overview +For shareable URLs that always point to the latest versions, see :doc:`/stable-links`. +---- -.. todo:: +.. dropdown:: Related Resources + :animate: fade-in - Add - - handbook - - overview - - flight-plans - - email-templates - - online meeting guidelines + - **Understand the design**: :doc:`/documentation/course-design/index` - why the course is designed this way + - **Learn to deliver**: :doc:`/documentation/guides/index` - practical how-to guidance + - **See what works**: :doc:`/documentation/patterns/index` - proven techniques .. toctree:: :hidden: diff --git a/source/course/index.rst b/source/documentation/course/index.rst similarity index 87% rename from source/course/index.rst rename to source/documentation/course/index.rst index 6ebe4d9..43a79bf 100644 --- a/source/course/index.rst +++ b/source/documentation/course/index.rst @@ -5,7 +5,10 @@ The Course .. admonition:: Under Review :class: warning - This page is currently under review. The copy needs to be updated. + This page is currently under review. + +.. TODO: Add 'For Educators' section - curriculum integration, age adaptations, academic calendar considerations +.. TODO: Add 'For Researchers' section - link to future Research track, methodology, evidence base, collaboration `Better Conversations `_ is at its heart, a course to teach people to have better conversations in everyday contexts using @@ -153,15 +156,17 @@ making it available under a `Creative Commons license (Attribution-ShareAlike this material and build their own work on top of it. The Foundation undertakes a number of activities to support people in -delivering the course that are outlined in the :doc:`/work-with-us/index` section. +delivering the course that are outlined in the :doc:`/documentation/work-with-us/index` section. Note that accessing the course content requires you to log in with your email address. -.. toctree:: - :maxdepth: 1 - :caption: Course Resources - :hidden: +---- + +.. dropdown:: Related Resources + :animate: fade-in + + - **Understand the design**: :doc:`/documentation/course-design/index` - why the course is designed this way + - **Get the materials**: :doc:`/documentation/course-materials/index` - handbook, flight plans, and more + - **Learn to deliver**: :doc:`/documentation/guides/index` - practical how-to guidance - 60-Handbook-and-emails - 70-Versioning diff --git a/source/documentation/delivery-checklists/index.rst b/source/documentation/delivery-checklists/index.rst deleted file mode 100644 index 7854910..0000000 --- a/source/documentation/delivery-checklists/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _delivery-checklists: - -=================== -Delivery Checklists -=================== - -These are the checklists that the Foundation run before every session. They are specific to how the Foundation run courses and are a collection of lessons -learned. We've included it with the flight plans so you can get some idea of what we do and can decide if you want to do something similar. - -These checklists are very BCF-specific. Whilst we hope it is useful, you may want to adapt this to your own needs for your own sessions. - -The Better Conversations Community is a place where you can discuss and learn from others how you use this checklist to reinforce the relevance of the -course to your wider context. If you aren't already a member you can get in touch here: `hello@betterconversations.foundation `_ - - -.. toctree:: - :hidden: - :maxdepth: 2 - :caption: Checklists in this section - - individual-checklist - team-checklist diff --git a/source/work-with-us/governance/articles/index.rst b/source/documentation/governance/articles/index.rst similarity index 100% rename from source/work-with-us/governance/articles/index.rst rename to source/documentation/governance/articles/index.rst diff --git a/source/work-with-us/governance/articles/part1.md b/source/documentation/governance/articles/part1.md similarity index 100% rename from source/work-with-us/governance/articles/part1.md rename to source/documentation/governance/articles/part1.md diff --git a/source/work-with-us/governance/articles/part2.md b/source/documentation/governance/articles/part2.md similarity index 100% rename from source/work-with-us/governance/articles/part2.md rename to source/documentation/governance/articles/part2.md diff --git a/source/work-with-us/governance/articles/part3.md b/source/documentation/governance/articles/part3.md similarity index 100% rename from source/work-with-us/governance/articles/part3.md rename to source/documentation/governance/articles/part3.md diff --git a/source/work-with-us/governance/articles/part4.md b/source/documentation/governance/articles/part4.md similarity index 100% rename from source/work-with-us/governance/articles/part4.md rename to source/documentation/governance/articles/part4.md diff --git a/source/work-with-us/governance/articles/part5.md b/source/documentation/governance/articles/part5.md similarity index 100% rename from source/work-with-us/governance/articles/part5.md rename to source/documentation/governance/articles/part5.md diff --git a/source/work-with-us/governance/board/index.rst b/source/documentation/governance/board/index.rst similarity index 100% rename from source/work-with-us/governance/board/index.rst rename to source/documentation/governance/board/index.rst diff --git a/source/work-with-us/governance/board/minutes-2025-02-27.rst b/source/documentation/governance/board/minutes-2025-02-27.rst similarity index 93% rename from source/work-with-us/governance/board/minutes-2025-02-27.rst rename to source/documentation/governance/board/minutes-2025-02-27.rst index 6c6b7cd..0b76cae 100644 --- a/source/work-with-us/governance/board/minutes-2025-02-27.rst +++ b/source/documentation/governance/board/minutes-2025-02-27.rst @@ -15,7 +15,7 @@ Minutes 2. The minutes of the previous meeting were read and approved. 3. The board discussed recent events and determined to adopt a Code of Conduct for the Foundation's community. The Code of Conduct - can be found `on this site `_. + can be found `on this site `_. 4. The board noted that involvement in the Foundation's acitivities is by invitation, which can be withdrawn at any time by the board. 5. It was further noted that selected individuals have disqualified themselves diff --git a/source/documentation/governance/index.rst b/source/documentation/governance/index.rst new file mode 100644 index 0000000..45c1883 --- /dev/null +++ b/source/documentation/governance/index.rst @@ -0,0 +1,35 @@ +===================== +Foundation Governance +===================== + +This is all a bit nerdy, but it's important to be transparent how we are structured and run. +(It is also public information you could find with a bit of digging, so we're not doing +anything magnificent sharing this, but it's good to be open about it.) + +**What's available:** + +- :doc:`structure` - how the Foundation is structured +- :doc:`articles/index` - our articles of association +- :doc:`board/index` - board meetings and minutes +- :doc:`members` - Foundation membership +- :doc:`ip-policy` - intellectual property policy + +---- + +.. dropdown:: Related Resources + :animate: fade-in + + - **Partnership**: :doc:`/documentation/work-with-us/index` - working with the Foundation + - **Community**: :doc:`/documentation/community/index` - code of conduct and participation + - **Using the course**: :doc:`/documentation/using-the-course/index` - practical usage details + +.. toctree:: + :maxdepth: 2 + :caption: Contents + :hidden: + + structure + articles/index + board/index + members + ip-policy diff --git a/source/work-with-us/governance/ip-policy.rst b/source/documentation/governance/ip-policy.rst similarity index 100% rename from source/work-with-us/governance/ip-policy.rst rename to source/documentation/governance/ip-policy.rst diff --git a/source/work-with-us/governance/members.rst b/source/documentation/governance/members.rst similarity index 91% rename from source/work-with-us/governance/members.rst rename to source/documentation/governance/members.rst index 2dedd42..5c43c2e 100644 --- a/source/work-with-us/governance/members.rst +++ b/source/documentation/governance/members.rst @@ -16,5 +16,5 @@ Foundation to operate. So the "Member" of the Foundation is Pithos Ltd, which is the holding company that owns Amphora Research Systems Ltd. The Foundation can't pay dividends, so any profits it makes will be used to further its objectives. -Note that generally when we talk about "members" we are referring to the members of the `Better Conversations community `_. +Note that generally when we talk about "members" we are referring to the members of the `Better Conversations community `_. It is only in the legal articles that the word "member" is used where you might normally expect "shareholder" in a for-profit company. diff --git a/source/work-with-us/governance/structure.rst b/source/documentation/governance/structure.rst similarity index 100% rename from source/work-with-us/governance/structure.rst rename to source/documentation/governance/structure.rst diff --git a/source/documentation/guides/checklists/index.rst b/source/documentation/guides/checklists/index.rst new file mode 100644 index 0000000..5176299 --- /dev/null +++ b/source/documentation/guides/checklists/index.rst @@ -0,0 +1,16 @@ +.. _delivery-checklists: + +=================== +Delivery Checklists +=================== + +These are the checklists that the Foundation run before every session. They are specific to how the Foundation run courses and are a collection of lessons learned. + +These checklists are BCF-specific. Whilst we hope they are useful, you may want to adapt them to your own needs. + +.. toctree:: + :maxdepth: 1 + :caption: Checklists + + individual-checklist + team-checklist diff --git a/source/documentation/delivery-checklists/individual-checklist.rst b/source/documentation/guides/checklists/individual-checklist.rst similarity index 100% rename from source/documentation/delivery-checklists/individual-checklist.rst rename to source/documentation/guides/checklists/individual-checklist.rst diff --git a/source/documentation/delivery-checklists/team-checklist.rst b/source/documentation/guides/checklists/team-checklist.rst similarity index 100% rename from source/documentation/delivery-checklists/team-checklist.rst rename to source/documentation/guides/checklists/team-checklist.rst diff --git a/source/documentation/guides/index.rst b/source/documentation/guides/index.rst index 0d9e510..9de6481 100644 --- a/source/documentation/guides/index.rst +++ b/source/documentation/guides/index.rst @@ -6,14 +6,28 @@ Guides These are the guides that the Foundation find useful in delivering courses - they are not meant to be prescriptive, but rather to be a starting point for you to find and adapt your own style. -The Better Conversations Community is a place where you can discuss and learn from others how you use this checklist to reinforce the relevance of the -course to your wider context. If you aren't already a member you can get in touch here: `hello@betterconversations.foundation `_ +The Better Conversations Community is a place where you can discuss and learn from others. If you aren't already a member you can get in touch here: `hello@betterconversations.foundation `_ +**What's available:** + +- :doc:`facilitator-guides/index` - guidance for facilitators +- :doc:`producer-guides/index` - guidance for producers +- :doc:`checklists/index` - preparation and delivery checklists + +---- + +.. dropdown:: Related Resources + :animate: fade-in + + - **Review the course**: :doc:`/documentation/course/index` - revisit modules and structure + - **See what works**: :doc:`/documentation/patterns/index` - proven techniques + - **Learn from experience**: :doc:`/documentation/insights/index` - learnings from hundreds of sessions .. toctree:: + :hidden: :maxdepth: 2 - :caption: Guides in this section + :caption: Contents facilitator-guides/index producer-guides/index - # guides-template \ No newline at end of file + checklists/index \ No newline at end of file diff --git a/source/documentation/index.rst b/source/documentation/index.rst deleted file mode 100644 index e3b9f70..0000000 --- a/source/documentation/index.rst +++ /dev/null @@ -1,55 +0,0 @@ -========= -Resources -========= - -If you're reading this, you're probably interested in learning how to -deliver the Better Conversations course. You'll find a lot of information -here, and we hope it's helpful. We've tried to keep it simple and easy to -refer back to. - -Please note that: - -- We do add content to this site regularly, so please check back often. -- You may need to sign in with your email address for some content. - -- There are some technical terms and concepts in the course. We've tried - to explain them as clearly as we can. If you're not sure about something, - or can't find what you're looking for, please ask us or post a question in the - `Community forum `_. - -- If you're new to the course, we recommend that you start with the - `Course Overview `_. - This will give you a good idea of what the course is about and how it's - structured. - -- For those of you who have been on the course, you might want to go straight to - the `Flight Plans `_. - These are the detailed plans for each session, and they include all the - information you need to deliver each module, along with the Course Handbook. - - -.. todo:: - Add - guides/index - our-processes/index - tips/index - course-improvement/index - quick-reference - booking/index - - - Add links to glossary, handbook, overview and community - - If we are using icons, add a key here - - Add glossary - - Add community - - Add acknowledgements for course documentation - -.. toctree:: - :maxdepth: 2 - :hidden: - - glossary - assumptions - badges - stable-links - course-improvement/index - fullsite-pdf diff --git a/source/documentation/insights/index.rst b/source/documentation/insights/index.rst index bacdc81..b4609a8 100644 --- a/source/documentation/insights/index.rst +++ b/source/documentation/insights/index.rst @@ -4,19 +4,35 @@ Insights ======== -These are a collection of learnings from our own experience over delivering many hundreds of sessions. +These are a collection of learnings from our own experience over delivering many hundreds of sessions. They are specific to the context we are in - your experience and perspective may be different. These are not patterns or guidance per se, but you might want to dip in to these to get a sense of what you might do in your own delivery. +**What's available:** + +- :doc:`flight-plan-usability-insight` - making flight plans easier to use +- :doc:`preparation-insights` - learnings about preparation +- :doc:`teams-vs-groups-insight` - understanding team dynamics +- :doc:`multiple-monitors-insight` - using multiple screens effectively + +.. todo:: + As we add more insights, include a folder for each section. This means the toctree will show the folder names + +---- + +.. dropdown:: Related Resources + :animate: fade-in + + - **Review the guides**: :doc:`/documentation/guides/index` - practical how-to guidance + - **See what works**: :doc:`/documentation/patterns/index` - proven techniques + - **Share your learnings**: :doc:`/documentation/community/improvements-and-suggestions` - contribute your insights + .. toctree:: :hidden: - :titlesonly: - :caption: Insights in this section + :maxdepth: 2 + :caption: Contents flight-plan-usability-insight preparation-insights teams-vs-groups-insight - multiple-monitors-insight - -.. todo:: - As we add more insights, include a folder for each section. This means the toctree will show the folder names \ No newline at end of file + multiple-monitors-insight \ No newline at end of file diff --git a/source/documentation/not_used/our-processes/index.rst b/source/documentation/not_used/our-processes/index.rst deleted file mode 100644 index 770c54b..0000000 --- a/source/documentation/not_used/our-processes/index.rst +++ /dev/null @@ -1,2 +0,0 @@ -Our Processes -============= \ No newline at end of file diff --git a/source/documentation/patterns/index.rst b/source/documentation/patterns/index.rst index 89802ea..dae6156 100644 --- a/source/documentation/patterns/index.rst +++ b/source/documentation/patterns/index.rst @@ -4,6 +4,43 @@ Patterns ======== +Our Approach to Sharing Knowledge +--------------------------------- + +Through thousands of hours designing and delivering Better Conversations, we've discovered what works reliably and what needs adjusting for context. We're sharing our experience to help you deliver the course effectively while honoring your own style. + +**What works reliably (patterns)** + +When we've tested something across many sessions and found it consistently effective, we document it as a "pattern" - a term borrowed from software development. These patterns represent proven approaches to common situations in Better Conversations delivery. + +Our patterns aren't rules or requirements. They're reliable solutions we've refined through experience. We encourage you to try them as described first - they work because specific elements combine in specific ways. Once you understand why they work, you'll be better equipped to adapt them to your context. + +**Where style and preference matter (guidance)** + +Some aspects of delivery are more flexible, influenced by facilitator style, group dynamics, or context. We document these as "guidance" notes - different approaches we've seen work well, each with its own benefits. + +Guidance acknowledges that skilled delivery teams might choose different paths to the same destination. We share multiple approaches so you can find what aligns with your natural style while serving your participants effectively. + +**Why we share this information** + +Transparency matters to us. By documenting both our reliable patterns and flexible guidance, we: + +- Help you understand the thinking behind course design decisions +- Support your development as a facilitator and/or producer +- Encourage informed adaptation rather than guesswork +- Build a community of practice where we all learn together + +**Your experience matters too!** + +These patterns and guidance aren't set in stone. They evolve as we learn. If you discover variations that work well, or if something doesn't work in your context, we want to know! Your experience contributes to the collective learning that makes Better Conversations better for everyone. + +Whether you're delivering our course or designing your own, these patterns provide tested starting points. Use what serves you, adapt what needs adapting, and please share what you learn with us. You can do this by `contacting us directly `_ or by `posting in our community `_. + +---- + +Patterns Library +---------------- + Patterns are the processes and techniques that we have found to be effective in delivering Better Conversations. They are not rules or requirements, but rather a starting point for you to adapt to your own context. .. todo:: Potential patterns @@ -26,3 +63,12 @@ Patterns are the processes and techniques that we have found to be effective in # timing-session-flow/index # visual-technical/index # roles/index + +---- + +.. dropdown:: Related Resources + :animate: fade-in + + - **Review the guides**: :doc:`/documentation/guides/index` - practical how-to guidance + - **Learn from experience**: :doc:`/documentation/insights/index` - learnings from hundreds of sessions + - **Share your discoveries**: :doc:`/documentation/community/improvements-and-suggestions` - contribute your patterns diff --git a/source/documentation/patterns/quick-reference/index.rst b/source/documentation/patterns/quick-reference/index.rst deleted file mode 100644 index e69de29..0000000 diff --git a/source/documentation/assumptions.md b/source/documentation/using-the-course/assumptions.md similarity index 100% rename from source/documentation/assumptions.md rename to source/documentation/using-the-course/assumptions.md diff --git a/source/work-with-us/course-definition.rst b/source/documentation/using-the-course/course-definition.rst similarity index 98% rename from source/work-with-us/course-definition.rst rename to source/documentation/using-the-course/course-definition.rst index a16d841..9b37030 100644 --- a/source/work-with-us/course-definition.rst +++ b/source/documentation/using-the-course/course-definition.rst @@ -10,7 +10,7 @@ We encourage people to take what we've done and do their own thing with it; a reasonable question is "at what point does it become a different course?". This is particularly important when people want to call their course "Better Conversations" and refer to the Better Conversations Foundation. It also defines who is eligible for -badges and certification as described in the `badges documentation `_. +badges and certification as described in the `badges documentation `_. If you want to call your course “Better Conversations”, and associate yourself with The Foundation, then this is what we need you to do. diff --git a/source/work-with-us/crediting.rst b/source/documentation/using-the-course/crediting.rst similarity index 100% rename from source/work-with-us/crediting.rst rename to source/documentation/using-the-course/crediting.rst diff --git a/source/documentation/using-the-course/index.rst b/source/documentation/using-the-course/index.rst new file mode 100644 index 0000000..6d5e163 --- /dev/null +++ b/source/documentation/using-the-course/index.rst @@ -0,0 +1,31 @@ +================ +Using the Course +================ + +This section covers the practical aspects of using the Better Conversations course - what assumptions we make, what counts as "Better Conversations", how versioning works, and how to credit the Foundation. + +**What's available:** + +- :doc:`assumptions` - what we assume about participants +- :doc:`course-definition` - what counts as "Better Conversations" +- :doc:`versioning` - how we version the course materials +- :doc:`crediting` - how to credit the Foundation + +---- + +.. dropdown:: Related Resources + :animate: fade-in + + - **Get the materials**: :doc:`/documentation/course-materials/index` - handbook, flight plans, and more + - **Partnership details**: :doc:`/documentation/work-with-us/index` - working with the Foundation + - **Community**: :doc:`/documentation/community/index` - code of conduct and participation + +.. toctree:: + :maxdepth: 2 + :caption: Contents + :hidden: + + assumptions + course-definition + versioning + crediting diff --git a/source/course/70-Versioning.rst b/source/documentation/using-the-course/versioning.rst similarity index 100% rename from source/course/70-Versioning.rst rename to source/documentation/using-the-course/versioning.rst diff --git a/source/documentation/badges.md b/source/documentation/work-with-us/certificates/badges.md similarity index 95% rename from source/documentation/badges.md rename to source/documentation/work-with-us/certificates/badges.md index b5ea3a3..b8cee0b 100644 --- a/source/documentation/badges.md +++ b/source/documentation/work-with-us/certificates/badges.md @@ -30,8 +30,8 @@ Attendee badges can be issued by: Note that the Foundation reserves the right to withdraw approval for any of the above at any time. -Whilst we don't mind what you call your course, you must give "Better Conversations" as defined -[here](/work-with-us/course-definition) which +Whilst we don't mind what you call your course, you must give "Better Conversations" as defined +[here](/documentation/using-the-course/course-definition) which includes following the flight plans, and delivering at least modules 1-5. diff --git a/source/documentation/work-with-us/certificates/index.rst b/source/documentation/work-with-us/certificates/index.rst new file mode 100644 index 0000000..9165ef2 --- /dev/null +++ b/source/documentation/work-with-us/certificates/index.rst @@ -0,0 +1,11 @@ +============ +Certificates +============ + +This section covers badges and certificates for course completion. + +.. toctree:: + :maxdepth: 2 + :caption: In this section + + badges diff --git a/source/documentation/work-with-us/index.rst b/source/documentation/work-with-us/index.rst new file mode 100644 index 0000000..0eb824c --- /dev/null +++ b/source/documentation/work-with-us/index.rst @@ -0,0 +1,50 @@ +=========== +Partnership +=========== + +We work with a wide range of partners to help us achieve our mission. We are always looking for new partners to work with, and we are open to new ideas and ways of working. + +We want to help people to help their teams, communities and organisations have better conversations. We believe that the best way to do this is to work with others who share our values and purpose. + +We'd especially like to hear from you if you are a non-profit, charity or social enterprise, or you work in a community or public sector organisation. We are also interested in working with businesses who share our values and purpose. + +This section explains what it means to work with the Better Conversations Foundation as a partner. We want to be clear about what we offer, what we expect, and how we work together. + +**What's available:** + +- :doc:`partnership/what-you-get` - how the Foundation supports you +- :doc:`partnership/expectations` - mutual expectations for partnership +- :doc:`partnership/service-levels` - support levels we offer +- :doc:`partnership/commercial` - our commercial arm +- :doc:`certificates/index` - badges and certificates + +.. todo:: + + - intro + - link to community support page + - add membership + - link to CC license + - Add customisation (changes.rst) + - Let us know + + TODO: Add 'For Advocates' section - business case, success stories, pitch materials + +---- + +.. dropdown:: Related Resources + :animate: fade-in + + - **Course definition**: :doc:`/documentation/using-the-course/course-definition` - what counts as "Better Conversations" + - **Community guidelines**: :doc:`/documentation/community/index` - code of conduct and participation + - **Governance**: :doc:`/documentation/governance/index` - structure, policies, and board + +.. toctree:: + :maxdepth: 2 + :caption: Contents + :hidden: + + partnership/what-you-get + partnership/expectations + partnership/service-levels + partnership/commercial + certificates/index diff --git a/source/work-with-us/commercial.rst b/source/documentation/work-with-us/partnership/commercial.rst similarity index 100% rename from source/work-with-us/commercial.rst rename to source/documentation/work-with-us/partnership/commercial.rst diff --git a/source/work-with-us/expectations.rst b/source/documentation/work-with-us/partnership/expectations.rst similarity index 100% rename from source/work-with-us/expectations.rst rename to source/documentation/work-with-us/partnership/expectations.rst diff --git a/source/work-with-us/service-levels.rst b/source/documentation/work-with-us/partnership/service-levels.rst similarity index 97% rename from source/work-with-us/service-levels.rst rename to source/documentation/work-with-us/partnership/service-levels.rst index 06c87ef..0a99824 100644 --- a/source/work-with-us/service-levels.rst +++ b/source/documentation/work-with-us/partnership/service-levels.rst @@ -53,6 +53,6 @@ from people how they've used our work. You can send us fan mail and feedback Commercial Support ------------------ -We offer commercial support for our courses `via our commercial arm `_. +We offer commercial support for our courses `via our commercial arm `_. Please `contact us `_ to discuss your needs. diff --git a/source/work-with-us/what-you-get.md b/source/documentation/work-with-us/partnership/what-you-get.md similarity index 98% rename from source/work-with-us/what-you-get.md rename to source/documentation/work-with-us/partnership/what-you-get.md index 153de47..2db959d 100644 --- a/source/work-with-us/what-you-get.md +++ b/source/documentation/work-with-us/partnership/what-you-get.md @@ -58,7 +58,7 @@ We will update this page with any updates to the support we can provide. ## Where can I find out more? Our intention is to enable others. You can find detailed documentation, guidance and materials in the -[Course Documentation](https://betterconversations.foundation/course/index.html) +[Course Documentation](/documentation/course/index.html) section of this site. Please note that for some of the content you'll need to sign in with your email address. diff --git a/source/documentation/fullsite-pdf.rst b/source/fullsite-pdf.rst similarity index 100% rename from source/documentation/fullsite-pdf.rst rename to source/fullsite-pdf.rst diff --git a/source/documentation/glossary.rst b/source/glossary.rst similarity index 98% rename from source/documentation/glossary.rst rename to source/glossary.rst index 4f78664..babeb91 100644 --- a/source/documentation/glossary.rst +++ b/source/glossary.rst @@ -41,7 +41,7 @@ and communicate effectively with others in the community. An individual or organisation in a formal relationship with the Better Conversations Foundation. Partners are authorised to deliver the Better Conversations course commercially and receive ongoing support from the - Foundation. See :doc:`/work-with-us/index` for more information. + Foundation. See :doc:`/documentation/work-with-us/index` for more information. Flight Plan A detailed design-and-delivery document for running a Better Conversations diff --git a/source/index.rst b/source/index.rst index d7195f3..651a79a 100644 --- a/source/index.rst +++ b/source/index.rst @@ -4,65 +4,141 @@ Stack of colorful books -=========================== -Documentation & Resources -=========================== +============================== +Documentation and Resources +============================== -Detailed resources for those working with Better Conversations — whether you're delivering the course within your organisation, integrating it into educational programmes, or conducting research. Here you'll find delivery guides, course materials, design rationale, and partnership guidelines. +This site provides detailed resources for those working with Better Conversations. Whether you're delivering the course within your organisation, integrating it into educational programmes, or conducting research, you'll find delivery guides, course materials, design rationale, and partnership guidelines here. -Looking for an overview of the Foundation or how to get started? Visit `betterconversations.foundation `_. +If you want an overview of the Foundation, to join the community, to book a discovery call, or to learn about our Ambassadors, visit `betterconversations.foundation `_. ------------ -Quick Links ------------ +We add content to this site regularly, so please check back often. You may need +to sign in with your email address for some content. + +.. raw:: html + +
+ +--------------------- +Delivering the Course +--------------------- + +.. Card order rationale: What→Why→How + Practitioners want to see what the course IS first (modules, structure), + then understand the design rationale, then learn how to deliver it. + +For practitioners, educators, and L&D teams learning to deliver Better Conversations. .. grid:: 2 2 3 3 :gutter: 3 - .. grid-item-card:: Flight Plans - :link: https://betterconversations.foundation/l/flightplans + .. grid-item-card:: :fas:`book-open` The Course + :link: documentation/course/index.html + :text-align: center - Session-by-session delivery scripts + Get an overview of the course modules, structure, and content - .. grid-item-card:: Course Handbook - :link: documentation/course-materials/handbook.html + .. grid-item-card:: :fas:`lightbulb` Course Design + :link: documentation/course-design/index.html + :text-align: center - Participant materials and resources + Understand the design principles behind the course - .. grid-item-card:: Delivery Guides + .. grid-item-card:: :fas:`tools` Delivery Resources :link: documentation/guides/index.html + :text-align: center - Guidance for delivering the course + Guides, patterns, checklists, and insights for delivering the course - .. grid-item-card:: Patterns - :link: documentation/patterns/index.html +**Quick start:** - Conversational patterns reference +- **New to the course?** Start with the `Course Overview `_ + to understand the course structure and what's involved. - .. grid-item-card:: Course Design - :link: documentation/course-design/index.html +- **Want to see the session plans?** Go straight to the `Flight Plans `_ + for detailed session-by-session delivery scripts (login required). + +- **Questions?** Check the :doc:`glossary` for terminology, or post in the + `Community forum `_ (login required). + +.. raw:: html + +
+ +-------------- +Working with Us +-------------- + +.. Card order rationale: Why→What→How + Organisations want to know why they should partner first (benefits, support), + then what's expected, then how the governance works. + +For organisations exploring partnership with the Foundation. + +.. grid:: 2 2 3 3 + :gutter: 3 + + .. grid-item-card:: :fas:`handshake` Partnership + :link: documentation/work-with-us/index.html + :text-align: center + + Why work with the Foundation - Design decisions and rationale + .. grid-item-card:: :fas:`file-contract` Expectations + :link: documentation/work-with-us/partnership/expectations.html + :text-align: center - .. grid-item-card:: Working with Us - :link: work-with-us/index.html + Understand what working with the Foundation means - Partnership guidelines and expectations + .. grid-item-card:: :fas:`sitemap` Governance + :link: documentation/governance/index.html + :text-align: center + Learn how we are organised and structured, and our policies + +**Quick start:** + +- **What support is available?** See :doc:`documentation/work-with-us/partnership/what-you-get` for how the Foundation helps partners. + +- **What can you expect from us?** Read our :doc:`documentation/work-with-us/partnership/expectations` for mutual commitments. + +- **Questions?** `Contact us `_ or post in the + `Community forum `_ (login required). + + +.. TODO: Add Research track toctree when content ready .. toctree:: :maxdepth: 2 - :caption: Contents + :caption: Delivering the Course :hidden: :numbered: 3 - course/index - documentation/index - documentation/course-materials/index + documentation/course/index documentation/course-design/index - documentation/patterns/index + documentation/course-materials/index documentation/guides/index - documentation/delivery-checklists/index + documentation/patterns/index documentation/insights/index - work-with-us/index + +.. toctree:: + :maxdepth: 2 + :caption: Working with Us + :hidden: + :numbered: 3 + + documentation/work-with-us/index + documentation/using-the-course/index + documentation/community/index + documentation/governance/index + +.. toctree:: + :maxdepth: 1 + :caption: Reference + :hidden: + + documentation/behind-the-scenes/index + glossary + stable-links + fullsite-pdf attributions diff --git a/source/stable-links.rst b/source/stable-links.rst new file mode 100644 index 0000000..6864d34 --- /dev/null +++ b/source/stable-links.rst @@ -0,0 +1,42 @@ +============ +Stable Links +============ + +Sometimes you need to link to a page that is not going to change, perhaps to send out to your course +participants or post in forums. No one likes a broken link! + +This is a list of links that are stable and will not change, and will redirect the user to the current correct page. For example, if we issue new flight plans or reorganise the site, https://betterconversations.foundation/l/flightplans will always take you to the current list of flight plans. + +Some material on this site is public, some requires a login, and that's also indicated in the table below. + +.. list-table:: + :widths: 30 40 20 + :header-rows: 1 + + * - URL + - Purpose + - Public + * - https://betterconversations.foundation/l/flightplans + - The master flight plans + - Public + * - https://betterconversations.foundation/l/handbook + - The current course handbook, as a PDF + - Public + * - https://betterconversations.foundation/l/license + - The definitive copyright page for the course material + - Public + * - https://betterconversations.foundation/l/attribution + - People often ask when and how they should reference us + - Public + * - https://betterconversations.foundation/l/masters + - The master flight plans + - Public + * - https://betterconversations.foundation/l/support + - Details of how you can get support for the material here + - Public + * - https://betterconversations.foundation/l/zoombor + - Our advice on how to do breakout rooms, and why + - Needs login + * - https://betterconversations.foundation/l/overview + - The current course overview, as a PDF + - Public diff --git a/source/work-with-us/governance/index.rst b/source/work-with-us/governance/index.rst deleted file mode 100644 index d47670e..0000000 --- a/source/work-with-us/governance/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -===================== -Foundation Governance -===================== - -This is all a bit nerdy, but it's important to be transparent how we are structured and run. -(It is also public information you could find bit a bit of digging, so we're not doing -anything magnificent sharing this, but it's good to be open about it.) - - - - -.. toctree:: - :maxdepth: 2 - :caption: Contents - :hidden: - - structure - articles/index - board/index - members - ip-policy diff --git a/source/work-with-us/index.rst b/source/work-with-us/index.rst deleted file mode 100644 index a896b23..0000000 --- a/source/work-with-us/index.rst +++ /dev/null @@ -1,34 +0,0 @@ -============ -Work with Us -============ - -We work with a wide range of partners to help us achieve our mission. We are always looking for new partners to work with, and we are open to new ideas and ways of working. - -We want to help people to help their teams, communities and organisations have better conversations. We believe that the best way to do this is to work with others who share our values and purpose. - -We'd especially like to hear from you if you are a non-profit, charity or social enterprise, or you work in a community or public sector organisation. We are also interested in working with businesses who share our values and purpose. - -.. todo:: - - - intro - - link to community support page - - add membership - - link to CC license - - Add customisation (changes.rst) - - Let us know - -.. toctree:: - :maxdepth: 2 - :caption: Contents - :hidden: - - what-you-get - expectations - service-levels - improvements-and-suggestions - crediting - course-definition - commercial - behind-the-scenes/index - governance/index - community/index