Skip to content

Commit

Permalink
[Docs] Update documentation and review docstrings (#5400)
Browse files Browse the repository at this point in the history
# Description
<!-- Please include a summary of the changes and the related issue.
Please also include relevant motivation and context. List any
dependencies that are required for this change. -->

- Deleted parameter explanations from a how-to guide for maintenance and
updated the code snippets. Added note referring to API reference.
- Reviewed default mkdocstrings options in mkdocs.yml for maintenance as
most files used the same options. Removed extra options from API
reference. Docstrings style chosen as google, because most of them was
using it.
- Reviewed docstrings: coherence across classes and methods, typos,
duplicated or missing information. Used ```python instead of >>>, so the
example code snippets can be directly run when copied.
- In questions, I also reviewed the type hinting for labels and the
error message.

Closes #5373 

**Type of change**
<!-- Please delete options that are not relevant. Remember to title the
PR according to the type of change -->

- Documentation update

**How Has This Been Tested**
<!-- Please add some reference about how your feature has been tested.
-->

**Checklist**
<!-- Please go over the list and make sure you've taken everything into
account -->
  • Loading branch information
sdiazlor authored Aug 12, 2024
1 parent e97dced commit a6fc011
Show file tree
Hide file tree
Showing 32 changed files with 213 additions and 434 deletions.
8 changes: 4 additions & 4 deletions argilla/docs/community/contributor.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Thank you for investing your time in contributing to the project! Any contributi
* **Discord**: You are welcome to join the [Argilla Discord community](http://hf.co/join/discord), where you can keep in touch with other users, contributors and the Argilla team. In the following [section](#first-contact-in-discord), you can find more information on how to get started in Discord.
* **Git**: This is a very useful tool to keep track of the changes in your files. Using the command-line interface (CLI), you can make your contributions easily. For that, you need to have it [installed and updated](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) on your computer.
* **GitHub**: It is a platform and cloud-based service that uses git and allows developers to collaborate on projects. To contribute to Argilla, you'll need to create an account. Check the [Contributor Workflow with Git and Github](#contributor-workflow-with-git-and-github) for more info.
* **Developer Documentation**: To collaborate, you'll need to set up an efficient environment. Check the [developer documentation](../getting_started/installation.md) to know how to do it.
* **Developer Documentation**: To collaborate, you'll need to set up an efficient environment. Check the [Server](https://github.com/argilla-io/argilla/blob/develop/argilla-server/README.md) and [Frontend](https://github.com/argilla-io/argilla/blob/develop/argilla-frontend/README.md) READMEs to know how to do it.
* **Schedule a meeting with our developer advocate**: If you have more questions, do not hesitate to contact our developer advocate and [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min).

## First Contact in Discord
Expand Down Expand Up @@ -70,7 +70,7 @@ git clone https://github.com/[your-github-username]/argilla.git
cd argilla
```

To keep your fork’s main/develop branch up to date with our repo, add it as an upstream remote branch. For more info, check the [documentation](../getting_started/installation.md).
To keep your fork’s main/develop branch up to date with our repo, add it as an upstream remote branch.

```sh
git remote add upstream https://github.com/argilla-io/argilla.git
Expand Down Expand Up @@ -117,11 +117,11 @@ A sample addition would be:
- Fixed the key errors for the `init` method ([#NUMBER_OF_PR](LINK_TO_PR)). Contributed by @github_handle.
```

You can have a look at the [CHANGELOG.md](https://raw.githubusercontent.com/argilla-io/argilla/develop/CHANGELOG.md) file to see more cases and examples.
You can have a look at the [CHANGELOG.md](https://github.com/argilla-io/argilla/blob/develop/argilla/CHANGELOG.md)) file to see more cases and examples.

### Make changes and push them

Make the changes you want in your local repository, and test that everything works and you are following the guidelines. Check the [documentation](../getting_started/installation.md) for more information about the development.
Make the changes you want in your local repository, and test that everything works and you are following the guidelines.

Once you have finished, you can check the status of your repository and synchronize with the upstreaming repo with the following command:

Expand Down
71 changes: 0 additions & 71 deletions argilla/docs/getting_started/installation.md

This file was deleted.

Loading

0 comments on commit a6fc011

Please sign in to comment.