Skip to content
Justin Quinn edited this page Apr 7, 2025 · 5 revisions

Hi there!

Welcome to the OneFeed wiki: the place for end users and developers to learn all things OneFeed!

⚠️Important Notice

As OneFeed is still actively in development and not yet completed, please do not take anything listed here as final (yet). As OneFeed inevitably changes, so will this wiki's content.

🏭This Wiki's Goals

Simply put, the wiki aims to help OneFeed's three types of users make informed decisions as they pursue their goals. If we're to break it down though, here are some more specific goals per user. As each of the users below, you can expect this wiki to help you in the following ways:

👤Consumers

  • Understand the advantages of OneFeed for consumers
  • Understand how OneFeed integrates into your application
  • Learn how to use OneFeed's endpoints

🧑‍💼Administrators

  • Understand the advantages of OneFeed for administrators
  • Understand how OneFeed integrates into your clients' applications
  • Learn how to tailor OneFeed to your needs
    • Configuring OneFeed
    • Customizing OneFeed as a developer
    • Adding new feeds to OneFeed
  • Understand OneFeed's terms of service
    • Appropriate usage
    • OneFeed's assurances
    • Risks of usage

🧑‍💻Developers

  • Understand OneFeed's guiding development principles
  • Understand how OneFeed works by default
    • OneFeed's structure
    • How data is handled
      • Modeling
      • Flows
    • Standard operations
      • Handling HTTP requests
      • Retrieving Content
      • Processing Content
      • Loading configurations
      • Loading customizations
  • Learn how to extend and customize OneFeed
    • Customization opportunities
    • Extension points
    • Developing ContentSource plugins
  • Understand OneFeed's terms of service
    • Appropriate usage

❓How to Use the Wiki

  1. Check out this wiki's Symbol Key to understand the meaning behind the symbols it uses
  2. Determine which user(s) you best align with using the provided guide as a reference
  3. Look in your respective page group(s) for information that best aligns with your needs
  4. Reference this wiki's Glossary when you need a refresher on OneFeed's specific terminology

🏭Meta

👤Consumers

  • OneFeed for Consumers
  • OneFeed and Your Application
  • OneFeed's Default Endpoints

🧑‍💼Administrators

  • OneFeed for Admins
  • OneFeed for Your Clients
  • Tailoring the Experience
    • Configuring OneFeed
    • Customizing OneFeed
    • Add New Feeds
  • OneFeed's Terms
    • Appropriate Usage
    • Assurances
    • Assumed Risks

🧑‍💻Developers

  • OneFeed for Devs
  • How OneFeed Works
    • App Structure
    • Data Handling
      • Data Modeling
      • Data Flows
    • Standard Operations
      • Handling Requests
      • Retrieving Content
      • Processing Content
        • Content Mapping
        • Text Formatting
      • Loading Configurations
      • Loading Customizations
  • OneFeed's Development Principles
  • Develop Customizations
    • Default Extension Points
    • How to Develop Content Sources

Clone this wiki locally