KnowledgeArticle

Struct KnowledgeArticle 

Source
pub struct KnowledgeArticle {
Show 21 fields pub id: Uuid, pub number: String, pub title: String, pub article_type: KnowledgeType, pub status: KnowledgeStatus, pub domain: Option<String>, pub summary: String, pub content: String, pub author: String, pub reviewers: Vec<String>, pub last_reviewed: Option<DateTime<Utc>>, pub review_frequency: Option<ReviewFrequency>, pub audience: Vec<String>, pub skill_level: Option<SkillLevel>, pub linked_assets: Vec<AssetLink>, pub linked_decisions: Vec<Uuid>, pub related_articles: Vec<RelatedArticle>, pub tags: Vec<Tag>, pub notes: Option<String>, pub created_at: DateTime<Utc>, pub updated_at: DateTime<Utc>,
}
Expand description

Knowledge Base Article

Represents a knowledge article that can be categorized by domain, type, and audience.

Fields§

§id: Uuid

Unique identifier for the article

§number: String

Article number (KB-0001, KB-0002, etc.)

§title: String

Article title

§article_type: KnowledgeType

Type of article

§status: KnowledgeStatus

Publication status

§domain: Option<String>

Domain this article belongs to (optional)

§summary: String

Brief summary of the article

§content: String

Full article content in Markdown

§author: String

Article author (email or name)

§reviewers: Vec<String>

List of reviewers

§last_reviewed: Option<DateTime<Utc>>

Date of last review

§review_frequency: Option<ReviewFrequency>

How often the article should be reviewed

§audience: Vec<String>

Target audience for the article

§skill_level: Option<SkillLevel>

Required skill level

§linked_assets: Vec<AssetLink>

Assets referenced by this article

§linked_decisions: Vec<Uuid>

UUIDs of related decisions

§related_articles: Vec<RelatedArticle>

Related articles

§tags: Vec<Tag>

Tags for categorization

§notes: Option<String>

Additional notes

§created_at: DateTime<Utc>

Creation timestamp

§updated_at: DateTime<Utc>

Last modification timestamp

Implementations§

Source§

impl KnowledgeArticle

Source

pub fn new( number: u32, title: impl Into<String>, summary: impl Into<String>, content: impl Into<String>, author: impl Into<String>, ) -> Self

Create a new knowledge article with required fields

Source

pub fn generate_id(number: u32) -> Uuid

Generate a deterministic UUID for an article based on its number

Source

pub fn parse_number(&self) -> Option<u32>

Parse the numeric part of the article number

Source

pub fn with_type(self, article_type: KnowledgeType) -> Self

Set the article type

Source

pub fn with_status(self, status: KnowledgeStatus) -> Self

Set the article status

Source

pub fn with_domain(self, domain: impl Into<String>) -> Self

Set the domain

Source

pub fn add_reviewer(self, reviewer: impl Into<String>) -> Self

Add a reviewer

Source

pub fn with_review_frequency(self, frequency: ReviewFrequency) -> Self

Set review frequency

Source

pub fn add_audience(self, audience: impl Into<String>) -> Self

Add an audience

Source

pub fn with_skill_level(self, level: SkillLevel) -> Self

Set skill level

Add an asset link

Link to a decision

Source

pub fn add_related_article(self, article: RelatedArticle) -> Self

Add a related article

Source

pub fn add_tag(self, tag: Tag) -> Self

Add a tag

Source

pub fn mark_reviewed(&mut self)

Mark the article as reviewed

Source

pub fn filename(&self, workspace_name: &str) -> String

Generate the YAML filename for this article

Source

pub fn markdown_filename(&self) -> String

Generate the Markdown filename for this article

Source

pub fn from_yaml(yaml_content: &str) -> Result<Self, Error>

Import from YAML

Source

pub fn to_yaml(&self) -> Result<String, Error>

Export to YAML

Trait Implementations§

Source§

impl Clone for KnowledgeArticle

Source§

fn clone(&self) -> KnowledgeArticle

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KnowledgeArticle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for KnowledgeArticle

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&KnowledgeArticle> for KnowledgeIndexEntry

Source§

fn from(article: &KnowledgeArticle) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for KnowledgeArticle

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for KnowledgeArticle

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for KnowledgeArticle

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,