Skip to content

Latest commit

 

History

History

domain_docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
acted_on_behalf_of.md
acted_on_behalf_of.md
 
 
activities_by_type.md
activities_by_type.md
 
 
activity.md
activity.md
 
 
activity_by_id.md
activity_by_id.md
 
 
activity_timeline.md
activity_timeline.md
 
 
activity_type.md
activity_type.md
 
 
agent.md
agent.md
 
 
agent_by_id.md
agent_by_id.md
 
 
agent_ref.md
agent_ref.md
 
 
agent_type.md
agent_type.md
 
 
agents_by_type.md
agents_by_type.md
 
 
association.md
association.md
 
 
attribution.md
attribution.md
 
 
define.md
define.md
 
 
end.md
end.md
 
 
end_activity.md
end_activity.md
 
 
entities_by_type.md
entities_by_type.md
 
 
entity.md
entity.md
 
 
entity_by_id.md
entity_by_id.md
 
 
entity_ref.md
entity_ref.md
 
 
entity_type.md
entity_type.md
 
 
external_id.md
external_id.md
 
 
generated.md
generated.md
 
 
had_primary_source.md
had_primary_source.md
 
 
id.md
id.md
 
 
identity.md
identity.md
 
 
instant_activity.md
instant_activity.md
 
 
namespace.md
namespace.md
 
 
prov_activity.md
prov_activity.md
 
 
prov_agent.md
prov_agent.md
 
 
prov_entity.md
prov_entity.md
 
 
role.md
role.md
 
 
start.md
start.md
 
 
start_activity.md
start_activity.md
 
 
type.md
type.md
 
 
unspecified.md
unspecified.md
 
 
used.md
used.md
 
 
was_associated_with.md
was_associated_with.md
 
 
was_attributed_to.md
was_attributed_to.md
 
 
was_derived_from.md
was_derived_from.md
 
 
was_generated_by.md
was_generated_by.md
 
 
was_informed_by.md
was_informed_by.md
 
 
was_quoted_from.md
was_quoted_from.md
 
 
was_revision_of.md
was_revision_of.md
 
 

README.md

DomainDocs

Chronicle documentation sources for use in doc comments in Rust code, with the aim of adding documentation capabilities to generated Chronicle domains and the GraphQL schema they produce.

Documentation in domain_docs/ duplicates and in some cases supplements Chronicle documentation in docs/.

Examples

//! crates/chronicle/src/codegen/mod.rs
//!
fn gen_type_enums(domain: &ChronicleDomainDef) -> rust::Tokens {
    // ...

    let role_doc = include_str!("../../../../domain_docs/role.md");

    //...

    quote! {
        #[doc = #_(#role_doc)]
        #[derive(#graphql_enum, Copy, Clone, Eq, PartialEq)]
        #[allow(clippy::upper_case_acronyms)]
        pub enum RoleType {
            Unspecified,
            #(for role in domain.roles.iter() =>
            #[graphql(name = #_(#(role.preserve_inflection())), visible=true)]
                #(role.as_type_name()),
            )
        }
    // ...
    }
}

The above example from codegen results in the following GraphQL schema:

# # `prov:Role`
#
# A role is the function of an entity or agent with respect to an activity, in
# the context of a usage, generation, invalidation, association, start, and end.
enum RoleType {
  UNSPECIFIED
  BUYER
  SELLER
  CREATOR
}