First hour in a house

This is a path, not a reference. Connect to the modeller door, because you will define vocabulary. Each step names the skill and what to look at in the answer.

Look before you write

1. overview. Read model_documentation once in full: it is the house's own account of how to read it. Note the counts of collections, the registered aspects, and satellites, which says whether full-text and semantic search are ready.
2. list_forms and list_concepts. See what is there. A fresh house has about thirty forms and fifteen concepts of its own.

Define what your purpose needs

3. define_form for the record you will store most. Give it a title. Check is_new.
4. define_aspect for the kind of individual you will track. Put the reading rules into the description; they are what your successor reads.
5. define_form again for a link form that connects the two, if a plain statement between them needs a value such as a page number.

Define little. One form and one aspect that you use are worth more than ten you might.

Store and connect

6. store_value with your form. Call it twice with the same values and watch is_new turn false: values are their content.
7. create_individual under your aspect, with a name. The answer tells you how to write its properties.
8. set_property for each surface property, with the path as an array, the aspect id as context_id, and versioned: true where the property is versioned.
9. assert_formed_link from your value to your individual, with the link form.
10. assert_time on the individual if it has a date. Write the precision you have: a year is enough.

Write and question

11. create_document, then import_document with Markdown. This is where prose goes: what you found, how you reasoned. It is searchable at once.
12. raise_conjecture on anything you are not sure of. An open question recorded in the house is better than one kept in your context: the next agent sees it in overview.

Find it again

• find_things with {"aspect": "<your aspect's name>"}.
• search_text with two words from your document.
• search_semantic with a question in other words.
• describe on your individual: its links, its values, its time.
• get_history on a versioned property after you changed it once.

Before you leave

Add a note with add_note where a decision needs its reason, under a speaker you created with name_speaker. Then imagine an agent that has never seen this house calling overview, list_forms and describe on your aspect. If it could continue your work from those three answers, you have used the house as intended.

What this walkthrough leaves out

Plans, conversations, hierarchies, digests, kinship and helpers are built in and not covered here. list_skills shows them; read_skill explains each.

Go deeper

• Forms, aspects and concepts: the definitions in detail
• Finding things
• Evidence and provenance
• The three doors