Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Contributing Guidelines, Code of Conduct, and Core Concepts Section to Documentation #3

Merged
merged 3 commits into from
Dec 1, 2024

Conversation

Cyb3rWard0g
Copy link
Owner

Summary

This PR enhances the Floki project by introducing essential documentation and guidelines, alongside a detailed "Concepts" section to support users in understanding the framework. These updates aim to improve developer onboarding, collaboration, and conceptual clarity for building and orchestrating LLM-based agents.

Key Changes

Contributing Guidelines

  • Added a CONTRIBUTING.md file with detailed instructions for:
    • Setting up the development environment.
    • Reporting issues and suggesting features.
    • Creating branches, making changes, and submitting PRs.
  • Guidelines for running and editing documentation locally using Docker.

Code of Conduct

  • Introduced a CODE_OF_CONDUCT.md file to establish community standards and ensure respectful collaboration.

Concepts Section

  • Added a new Concepts section to the documentation, featuring:
    • Why Floki?: Explains the purpose, unique features, and advantages of using Floki for agentic workflows.
    • Core Principles: Highlights foundational principles, including modular architecture, pub/sub messaging, and workflow-oriented design.
    • Detailed introductions to key components such as:
      • Agents: LLM-powered systems for autonomous reasoning and task execution.
      • Workflows: Deterministic and event-driven orchestration of agent collaboration.
      • Tools: Extending agent capabilities for real-world task integration.
      • Memory: Options for managing context across interactions, from in-memory lists to state stores.
      • LLMs: Explains the role of LLMs as reasoning engines and structured outputs like function calling.

Impact

These changes:

  • Provide a clear entry point for new contributors.
  • Help users understand the philosophy and design of Floki.
  • Establish a strong foundation for building multi-agent systems and workflows.
  • Simplify documentation management with clear local build instructions.

Next Steps

  • Continue refining the Concepts section as Floki evolves.
  • Expand documentation with examples and deeper dives into advanced topics like pub/sub messaging and workflows.

@Cyb3rWard0g Cyb3rWard0g merged commit 36d65ec into main Dec 1, 2024
@Cyb3rWard0g Cyb3rWard0g deleted the docs/initial-guidelines branch December 1, 2024 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant