Skip to content

Commit

Permalink
doc: v1.0 docs (#527)
Browse files Browse the repository at this point in the history
  • Loading branch information
creatorrr authored Sep 30, 2024
1 parent 98d322b commit 29de891
Show file tree
Hide file tree
Showing 300 changed files with 2,897 additions and 31,703 deletions.
40 changes: 40 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# 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, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, 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 [INSERT EMAIL ADDRESS]. 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.

62 changes: 62 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Support for Julep

Welcome to the Julep support page! We're here to help you with any questions or issues you may encounter while using our platform. This document outlines the various ways you can get support and engage with our community.

## Getting Help

### Documentation

Our comprehensive documentation is the first place to look for answers:

- [Explore Docs](https://docs.julep.ai)

Here you'll find detailed guides, API references, and tutorials to help you make the most of Julep.

### Community Support

Join our vibrant community to get help from other users and the Julep team:

- [Discord](https://discord.com/invite/JTSBGRZrzj): Join our Discord server for real-time chat and support.
- [GitHub Discussions](https://github.com/julep-ai/julep/discussions): Ask questions, share ideas, and discuss Julep with other developers.

### Social Media

Follow us on social media for updates, tips, and community highlights:

- [𝕏 (Twitter)](https://x.com/julep_ai)
- [LinkedIn](https://www.linkedin.com/company/julep-ai)

## Reporting Issues

If you encounter a bug or have a feature request, please open an issue on our GitHub repository:

- [GitHub Issues](https://github.com/julep-ai/julep/issues)

When reporting issues, please provide as much detail as possible, including:

- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Any error messages or logs
- Your environment (Julep version, operating system, etc.)

## Contributing

We welcome contributions to Julep! If you're interested in contributing, please check out our:

- [Contributing Guidelines](https://github.com/julep-ai/julep/blob/main/CONTRIBUTING.md)
- [Code of Conduct](https://github.com/julep-ai/julep/blob/main/CODE_OF_CONDUCT.md)

## API Keys

While we are in beta, you can reach out on [Discord](https://discord.com/invite/JTSBGRZrzj) to get your API key.

## Staying Updated

To stay informed about the latest updates, features, and community news:

- Watch our [GitHub repository](https://github.com/julep-ai/julep)
- Follow us on [𝕏 (Twitter)](https://x.com/julep_ai)
- Join our [Discord](https://discord.com/invite/JTSBGRZrzj) for announcements

Thank you for using Julep! We're excited to see what you build with our platform.
6 changes: 6 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[submodule "sdks/node-sdk"]
path = sdks/node-sdk
url = https://github.com/julep-ai/node-sdk.git
[submodule "sdks/python-sdk"]
path = sdks/python-sdk
url = https://github.com/julep-ai/python-sdk.git
Loading

0 comments on commit 29de891

Please sign in to comment.