Struct Docs 

pub struct Docs {
    pub architecture: Option<String>,
    pub vision: Option<String>,
    pub contributing: Option<String>,
}

Configurable paths to the project’s reference documentation, relative to the project root. Used by joy ai init to support existing repos with non-default doc layouts and read by AI tools via joy project get docs.<key>.

Fields

architecture: Option<String>

vision: Option<String>

contributing: Option<String>

Implementations

impl Docs

pub const DEFAULT_ARCHITECTURE: &'static str = "docs/dev/architecture/README.md"

pub const DEFAULT_VISION: &'static str = "docs/dev/vision/README.md"

pub const DEFAULT_CONTRIBUTING: &'static str = "CONTRIBUTING.md"

pub fn is_empty(&self) -> bool

pub fn architecture_or_default(&self) -> &str

Configured architecture path or the default if unset.

pub fn vision_or_default(&self) -> &str

Configured vision path or the default if unset.

pub fn contributing_or_default(&self) -> &str

Configured contributing path or the default if unset.

Trait Implementations

impl Clone for Docs

fn clone(&self) -> Docs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Docs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Docs

fn default() -> Docs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Docs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Docs

fn eq(&self, other: &Docs) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Docs

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Docs