Skip to content

Move documentation from READMEs into this repository #6

@stschiff

Description

@stschiff

I think embedding the existing READMEs for trident, the standard, and so forth, was very clever, and it certainly has the advantage that we can keep the documentations for trident, standard and PoseidonR in their respective packages. At least for trident and the standard, however, I somehow feel it also hampers flexibility to maintain and develop this webpage further. For example, it could make sense to weave the individual docs more together to create a comprehensive overview or getting started page, or to document the server API together with trident, or such things.

I would suggest to move the individual documentations here directly into this website-repository, and replace the original READMEs with some basic info and then a link to this webpage. This would allow us to freely design this webpage to be maximally user-friendly and engaging, without the danger to compartmentalise the docs for the individual parts.

(Note that copying the READMEs over here with a gh-action won't help, I think, as it still would mean that we are forced to keep the documentations as separate chapters.)

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