Compare commits

...
+49 -22
View File
@@ -1,8 +1,9 @@
# Your books in Mosaic: a setup sheet
This sheet is for you, Melanie. You keep writing in Obsidian the way you do now. Mosaic reads your
books repo after obsidian-git pushes it to git.mosaicstack.dev. It changes nothing on your machine and
commits nothing to your repo.
books repo after obsidian-git pushes it to git.mosaicstack.dev. Mosaic does not write directly to your
Obsidian vault. Each Console save and each note an agent writes becomes a commit in your repo. Your
computer gets those changes when obsidian-git pulls them.
## What the agents read
@@ -14,7 +15,9 @@ They read notes, the `.md` files, inside your book folders. They don't read:
- images and other attachments
- anything in your other repos under `~/src`
They can't write to your repo at all. That covers canon, the playground and everything else.
They never write story or canon files. They may create, edit or delete `.md` notes only inside folders
you mark as `supporting`. A folder not marked `supporting` stays read-only to agents, including the
playground. A folder may be both `playground` and `supporting`.
Which folders are book folders, and which hold characters, places, research, your tracker or chapter
summaries, is set in one place. It is the `projects` entry of your business file in Mosaic. Jason
@@ -30,13 +33,14 @@ at one of three levels:
world you are only starting. When it is real, Jason turns it into a plain universe with books and you
move the notes in Obsidian.
You choose the names and tell Jason. Until you have one, every note in a book folder is canon.
You choose the names and tell Jason. Until you mark a folder as `playground` or `supporting`, notes in
book folders are treated as canon.
What the playground means for the agents:
- They search canon unless they ask for the playground on purpose.
- An agent may quote a playground note in an idea or a question. It may not use one to back a fact,
a finding or a correction. Mosaic refuses that reply before you see it.
- Only the folder decides. A tag or a property can't make a note playground or canon.
- They may cite a playground note. The Console shows that it is playground, not canon.
- Only the folder decides. A tag or a property can't make a note playground or canon. A playground
folder is writable only when it is also marked `supporting`.
### Colour the playground in your graph
@@ -50,14 +54,36 @@ This is a setting of your own vault. It changes nothing for the agents.
Add one group per playground folder.
## Supporting folders
A folder you mark as `supporting` is where agents may write `.md` notes. They cannot write anywhere
else. A folder you have not marked is story, and agents leave it alone. A folder can be both
`playground` and `supporting`; then agents can search it when asked and can write supporting notes
there.
Tell Jason which folders you want to mark. He adds them to the `supporting` list in the `projects`
entry of your business file. He edits that entry by hand, and you can ask him to add or change a folder
later.
## Saves and agent notes
When you save a file in the Console, Mosaic makes a commit under the name and email you give Jason for
`editor` in your `projects` entry. If that file moved after you opened it, Mosaic refuses the save and
keeps your text so you can copy it or try again.
Each time an agent creates, edits or deletes a supporting note, Mosaic makes a commit under that
agent's own name and shows you a notice in the Console with a Revert button. Mosaic's own notices do
not need a citation. Obsidian sees the change on its next pull. Supporting notes may contain any text.
You can read and revert every one.
## Two things you might not expect
### Moving a note into a book folder makes it canon
### Moving a note can change how agents use it
The folder decides, so a move changes what the agents may do with a note. Once you move a note out of
the playground into a book folder and push, it is canon. The agents may then cite it as fact. A note
that isn't settled yet belongs in the playground. Any note in a book folder outside the playground is
canon, rough drafts included.
the playground into a book folder and push, agents may treat it as canon unless it is inside a folder
you marked `supporting`. A note that isn't settled yet belongs in the playground. Any folder you mark
`supporting` stays a supporting folder even when it is inside a book folder.
### A short link can point somewhere else for the agents
@@ -106,18 +132,19 @@ value written without `[[ ]]` counts as a plain name, not a link.
They keep their names and personalities. How they answer changes.
In Hermes they answer in free text and may write story text when you ask. In Mosaic every reply is a
short list of items. Each item is an idea, a question, a finding or a fact. Each one quotes a line
from your repo or from a web page the agent read for you.
In Mosaic they can answer in free text, not a short list of items. There is no word-count or item-count
limit. They may cite your files, and the Console shows where each citation points. Citations are
optional by default. You or Jason can change these settings:
They don't write passages. If you ask for prose, you get a question or an idea instead.
| Setting | Default | What it does |
|---|---:|---|
| `requireCitation` | `false` | When true, each answer needs a citation. Mosaic's own notices do not. |
| `citationsPerReply` | `20` | Maximum citations in one answer. |
A reply holds at most 10 items and at most 1,200 characters of item text in all. It has at most 5
ideas of up to 200 characters each. A question, finding or fact runs up to 300 characters. You or
Jason can ask for lower limits. When an agent can't back an answer with a quote, you see "No cited
answer" instead.
File citations in one answer must stay within one universe.
Each book world stays separate. One item can't mix quotes from two worlds.
They can give free-text answers that cite your books. Their repository writes are limited to `.md`
notes in folders you marked `supporting`.
You talk to them in the Console. Hermes keeps running until you have moved over, and stopping it is
your choice.
@@ -127,5 +154,5 @@ choose which ones to start with, and you can add one later.
## What Jason will ask you
He will ask you to confirm your book folders and type folders, which books share a world, the name of
each playground folder, and which helpers to start with and when.
He will ask you to confirm your book folders, which books share a world, your playground and supporting
folders, the name and email for `editor`, and which helpers to start with and when.