Skip to content

Confusing docs language #71

@BenJackGill

Description

@BenJackGill

At the top of the front page for this repo it says:

Sync packages when deploying monorepos with firebase using yarn or bolt workspaces

Have you ever have a problem when deploying npm package with monorepos inside firebase functions ? You are really lucky then! Skip this library!'

This suggests that firelink library does NOT work for npm wordspace monorepos.

But further down the page it says:

The only purpose is to copy mapped modules inside package.json before working with firebase CLI. This way when deploying application npm will install packages locally file:./.packages/database instead from global registry.

This suggests it DOES work for npm wordspace monorepos.

The language is conflicting. I original ignored this package because I thought it only worked with yarn or bolt. Then I came a few days later after I realised I was wrong, it does work for npm workspaces. And I think many others users have also been driven away by the confusion.

Suggestion 1) Add npm to the top line:

Sync packages when deploying monorepos with firebase using yarn or bolt or npm workspaces

Suggestion 2) Delete this line:

Have you ever have a problem when deploying npm package with monorepos inside firebase functions ? You are really lucky then! Skip this library!'

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions