Skip to content

Shorter nexus.json summaries #1519

Closed
@benjaminleonard

Description

@benjaminleonard

Our long summaries are not ideal for readability within documentation. My proposal is that we make them shorter, and if necessary supplement the descriptions in cases where we feel like the shorter summary does not provide enough context.

I have spoken with @ahl about this – and I think is probably part of larger documentation improvements. I roughly made tweaks for testing the new docs site on the shorter summary branch. Not that this should be taken as a recommendation on specific summaries, but the length and approximate style that I think would work well.

For comparison:

If possible would like to remediate this before we push the new site live, so we are not out of sync. @ahl is there anything I can do to assist? If you could give me a run down on a rough style, e.g. fetch vs get – then I am happy to create a PR.

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