https://github.com/fetchai/docs-archived

This repo contains documentation for public Fetch.ai products.

https://github.com/fetchai/docs-archived

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary

Keywords

aea agents autonomous-agents autonomous-economic-agents decentralized-network ledger multi-agent-systems
Last synced: 4 months ago · JSON representation

Repository

This repo contains documentation for public Fetch.ai products.

Basic Info
  • Host: GitHub
  • Owner: fetchai
  • License: apache-2.0
  • Language: Makefile
  • Default Branch: master
  • Homepage: https://docs.fetch.ai/
  • Size: 185 MB
Statistics
  • Stars: 58
  • Watchers: 23
  • Forks: 42
  • Open Issues: 13
  • Releases: 0
Archived
Topics
aea agents autonomous-agents autonomous-economic-agents decentralized-network ledger multi-agent-systems
Created over 6 years ago · Last pushed over 2 years ago
Metadata Files
Readme Contributing License Code of conduct

README.md

GitHub contributors GitHub Pipenv locked Python version Docs sanity checks and tests

Clone

This repository contains submodules. Clone with recursive strategy:

git clone https://github.com/fetchai/docs.git --recursive && cd docs

Retrieve submodules

Ensure you retrieve all the submodules by running:

git submodule update --init --recursive

Update submodules

To update all your submodules to the latest versions of the main branch in their respective remote repos:

git submodule update --remote

To build the documentation locally

To compile and build the documentation site locally, download and install pipenv. Instructions are here.

Then run make new-env. This creates a new pipenv virtual environment and installs the required dependencies.

Then pipenv shell to enter the pipenv virtual environment.

Then run mkdocs serve and navigate to http://127.0.0.1:8000.

If you run in --strict mode, you will receive warnings about any broken links.

Making changes

  • For docs in submodules (e.g. aea) open a PR against the relevant repo (develop branch) and wait until the changes hit master. Then in this repo, open a PR containing an update to the aea submodule (see update submodule above).

  • For docs on the docs repo, make changes directly and open a PR against master branch of the docs repo.

Previews and Staging

  • Any changes made to a PR will generate an ephemeral preview site on firebase, which will disappear after a couple of days. The URL of this temporary site will be added to the PR's conversation.

  • Any changes pushed to the staging branch will be deployed to the preview website, and will not expire.

Deployment

Request the deploy.sh script from a maintainer and run it.

Owner

  • Name: Fetch.AI
  • Login: fetchai
  • Kind: organization

GitHub Events

Total
  • Watch event: 2
  • Fork event: 1
Last Year
  • Watch event: 2
  • Fork event: 1