---
# System prepended metadata

title: Baal Docs Sync
tags: [' baal', ' documentation', v3]

---

---
tags: v3, baal, documentation
---

# Baal Docs Sync

https://docs.google.com/document/d/1nlh4do7dIDQssKdswovRhF5XDr3dPHEaFA7_mbHy_1U/edit?pli=1#

new structure:

```
Interfaces (previously Contracts)
  Overview
  Loot
  Shares
Tools
  Shamans
  Minions
Configuration
  Admin Config
  Governance Config
Functions
Events
Baal CLI
```

## Notes

- Contract section can be more about the architecture instead of the code itself since that's on GH
- Contracts -> Interfaces with diagram about how the loot/share token relate to Baal
- Explain how the shares/loot work and are split out
- Contracts section can include the Interface
  - go through the main Interface points 
  - Code snippet of the Interface with explanation
  - Will be useful for builders to quickly see this
  - Can also include a flowchart or diagram (expand on this)
  - Add the shares token too
- How to use the docs
  - How the docs are structured
- Tools
  - Focus on shamans and minions
  - Pages:
    - shamans and minions
    - would include more detail and examples for each
- Configuration
  - Admin Config
  - Governance Config
  - Game Theory
    - Explanations around the voting periods/proposal offerings/config
    - Integrate in each section with examples/block quotes
    - Game theory examples and links for references
      - Spencer and Dekan have some links and resources
    - *Callouts* that are included in the docs where they make sense and then have another section on Game Theory Resources
- Functions
  - Go through each function and separate by public/external and internal/private
  - Expand on each of these sections with code snippets with explanations with potential usage
    - Include the code comments and see if there's any additional useful context
  - Examples
    - Show examples for each function and how you'd interface with it
    - Most are straightforward but the examples could be more about how to submit a proposal/multicall
      - maybe this is another section
    - Start writing this and then see where we want it to be
- Events
  - Go through here and then add callouts / examples where they make sense
  - Potentially grouped into an Examples section
  - This would support lots of different learning styles -- some folks may jump right into the examples section and others may do a deep dive into the events
- Baal CLI
  - Motivation / reason for using this
  - Go through each command and document each
  - Commands are in the tasks config -- look into the `tasks` for each one
    - Can use the `tasks help` command -- is there a command to export these?
      - This will print out the information / docs for the task

### Callouts
- Standardize these into categories:
  - Example
    - Direct code examples
  - Game Theory
    - Game Theory considerations for relevant section
  - General Note
    - Things that have informed the design of Baal
    - More generic, but we can see if we have a lot about the design of Baal 
    - See what other categories may emerge

## Questions

- What branch are we working from for our documentation?
  - https://github.com/HausDAO/Baal -- `feat/baalZodiac`
  - Include a list of addresses for the deployed contracts
    - Link to the wiki page for this
- Our git flow
  - Merges into `main` are deployed
  - PRs into main for the workflow
- Do we like the current information architecture/content map for the docs site or do we need to change anything?
- Down the road, what do we want for a subdomain, something like baal.daohaus.club?
  - ideas:
    - summon.daohaus.fun, hub.daohaus.fun, baal.daohaus.fun

## Next Steps

- Update the structure and then start writing the content
  - See what emerges after this
- Clean up the feature branches from Christina's edits