Skip to content

Expand documentation for constructing Article objects #945

Description

@SJang1

Summary

The documentation includes basic Article examples in the pragmatics manual and the Astro blog tutorial, but it does not provide consolidated guidance on how to model an article as an ActivityPub object.

Users currently need to infer which properties to use, what values they accept, and how Fedify's TypeScript properties are serialized into ActivityStreams JSON-LD.

What's Missing or Incorrect?

The documentation at least should clarify topics such as:

  • Which Article properties are required, recommended, or optional in practice
  • How application-level article fields map to properties such as id, url, attribution, name, summary, content, mediaType, source, published, updated, attachments, and tags
    ...etc

Related Code / Feature

  • @fedify/vocab's Article class
  • The properties inherited from the ActivityStreams Object class
  • Object dispatchers and Create activities

AI assistance disclosure

This issue was drafted with assistance from Codex:GPT-5.6 and reviewed and edited by the submitter(SJang1).

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Fields

    Priority

    Low

    Effort

    Medium

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions