Updating documentation (#42)

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at support@revelry.co. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -1,7 +1,23 @@
-# Contributing
+# Contributing and Development
 
 ## API Key
 
 You'll need a [ProdOps API key](https://help.prodops.ai/docs/api/get-your-api-token)
 to get started. Copy `config/config.example-secret.exs` to
 `config/config.secret.exs` and put your API key into that file.
+
+## Development Setup
+
+1. Make sure you have Elixir 1.16+ installed
+1. Clone the repo
+1. Run `mix deps.get`
+1. Run `mix test`
+
+## Submitting Changes
+
+1. Fork the project
+1. Create a new topic branch to contain your feature, change, or fix.
+1. Make sure all the tests are still passing.
+1. Implement your feature, change, or fix. Make sure to write tests, update and/or add documentation.
+1. Push your topic branch up to your fork.
+1. Open a Pull Request with a clear title and description.

README.md

@@ -1,11 +1,26 @@
-# ProdopsEx
+# ProdopsEx: The Prodops Elixir SDK
 
-The Elixir SDK for ProdOps
+ProdopsEx allows for access to the powerful Prodops API via Elixir. 
+This SDK allows for the creation and refinement of artifacts (content) within a ProdOps team.
+Other features include data center document, uploads, project management and more. 
+
+## Motivation
+
+To provide a simple way to interact with the Prodops API from within Elixir.
+
+## Build Status
+
+![tests](https://github.com/revelrylabs/prodops_ex/actions/workflows/test.yml/badge.svg)
+
+## Key Features
+- Create and manage artifacts (content) within a ProdOps team.
+- Refine existing artifacts.
+- Upload documents to ProdOps data center.
+- Stream the creation and refining of artifacts.
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `prodops_ex` to your list of dependencies in `mix.exs`:
+Add ProdopsEx to your mix.exs:
 
 ```elixir
 def deps do
@@ -15,10 +30,16 @@ def deps do
 end
 ```
 
+Fetch dependencies:
+
+```
+mix deps.get
+```
+
 [Sign up for a ProdOps account](https://app.prodops.ai) if you don't already
 have one, then go to Settings -> Team -> Manage Team Details to get your API
-key. If you don't see Manage Team Details, you will need to ask a ProdOps
-administrator on your team for access.
+key. If you don't see Manage Team Details, you will need to ask an administrator 
+on your team for access. More into can be found on our [help site](https://help.prodops.ai/docs/api/get-your-api-token).
 
 Put the API key somewhere in your application configuration, such as
 `dev.secret.exs`:
@@ -27,8 +48,55 @@ Put the API key somewhere in your application configuration, such as
 config :prodops_ex, api_key: "YOUR_API_KEY"
 ```
 
+## Usage
+
+Create a new artifact in ProdOps
+
+```elixir
+params = %{
+      prompt_template_id: 2,
+      artifact_slug: "story",
+      inputs: [
+        %{name: "Context", value: "this is a test"}
+      ],
+      fire_and_forget: true
+    }
+
+artifact = ProdopsEx.Artifact.create(params)
+```
+
+This will create a new artifact of the given artifact type for the given team matching the api token placed in the config. 
+
+```elixir
+{:ok, %{"artifact_id" => 123, "status" => "created"}}
+```
+
+
+### ProdOps.AI Definitions 
+- Team: Synonymous with Company or Organization.  Teams can have one or many Users.  Teams can have details that define who they are, what they do, and what their culture represents.  Q: Are there constraints or limiters on Teams (e.g. domain) 
+- Users: A member of a team.  A person who uses ProdOps.AI to create something.  Users are defined by email address and constrained by that email address to one Team.  
+- Project: A software development (or other) project, product, or idea, generally defined with a goal.  A ProdOps project could have a start and a finish, like a typical project (Build a wordpress marketing site for NOLA PD; Update the Revelry website with new creative and branding).  As well, a ProdOps project could be an ongoing effort, such as a product (Platform, Peerbot, Apple Music).  At its most basic, a ProdOps project is the subject that will drive the types of content that will be generated.  
+- Artifact Types: Every piece of content generated in ProdOps has a type, which determines the purpose, format, and types of prompt used in generating the thing. Users define their own prompt template types based on their needs.
+- Prompt templates / Prompt / Template: A re-usable template that contains both dynamic and static data. When the user is generating an artifact, this is what they will interact with, and that collaboration is what is sent to the LLM. Prompt templates are grouped by the type of artifact selected.
+
+
+## Contributing and Development
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/revelrylabs/prodops_ex. Check out the [contributing guidelines](CONTRIBUTING.md) for more info.
+
+Everyone is welcome to participate in the project. We expect contributors to adhere to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Releases
+
+See [RELEASES.md](RELEASES.md) for details about the release process.
+
 ## Documentation
 
 Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at <https://hexdocs.pm/prodops_ex>.
+and published on [HexDocs](https://hexdocs.pm). Docs can be found at <https://hexdocs.pm/prodops_ex>.
+
+Prodops.AI documentation can be found on the [help site](https://help.prodops.ai).
+
+## License
+
+ProdopsEx is released under the MIT License. See the [LICENSE](LICENSE) file for details.

RELEASES.md

@@ -0,0 +1,10 @@
+# Releasing a new version
+
+## Preparation
+- [ ] Update the package version in `mix.exs`
+- [ ] Update the package version badge and installation instructions in `README.md`
+
+## Release Process
+- [ ] Make sure all changes in the `Preparation` section are in `main`
+- [ ] In GitHub, create, and publish, a new release with appropriate notes, and version matching the package version `mix.exs`
+- [ ] The github actions workflow should automatically publish the package and docs to hex

mix.exs

@@ -14,9 +14,9 @@ defmodule ProdopsEx.MixProject do
       name: "ProdopsEx",
       source_url: "https://github.com/revelrylabs/prodops_ex",
       docs: [
-        main: "ProdopsEx",
+        main: "readme",
         logo: "prodops-logo.png",
-        extras: ["README.md"]
+        extras: ["README.md", "LICENSE", "CONTRIBUTING.md", "RELEASES.md", "CODE_OF_CONDUCT.md"]
       ]
     ]
   end