Marfeel Docs

# Ownership

Everyone at Marfeel is owner of MarfeelDocs. This article explains the expectations depending on your role.

# Codeowners

Code owners are automatically requested for review when someone opens a pull request that modifies code that they own. In Marfeel, every repository has a CODEOWNERS file that defines who the code owners are depending on the type of repository or file.

For everything related to documentation the following CODEOWNERS are defined as:

docs/ @Marfeel/pm
 \*.md @Marfeel/pm

This means that any markdown file or any document under the docs folder will need the approval of a PM.

# Global ownership

MarfeelDocs relies on every Marfeeler to stay up to date. Whenever you find a broken link, outdated content, missing information, etc. you should report it, either informing the Ada team or, ideally, opening a PR with the solution.

# Developer role

When adding a new feature, or modifying an existing one, the documentation should be part of the task. Making sure MarfeelDocs contains all the necessary information to start (or keep) using that feature.

# PMs role

PMs are responsible to create the first draft of non-technical docs and find the proper structure for the entire project. PMs are also responsible to connect the dots, cross-link projects and give the right context to a project in the Marfeel Platform ecosystem. PMs are the owners of all public-facing documentation.

# EMs role

EMs are responsible to create or coordinate the creation of technical docs needed by other Marfeel teams as well as team internal documentation aimed at onboardings.

Once the initial documentation exists all individual contributors become owners and champions of the documentation:

  • Team developers are responsible to keep the documentation updated with every minor change made to the source code.

  • "External" developers from other teams are invited to submit PRs with deeper and more detailed examples that can benefit the whole developer ecosystem.

← Architecture →