Skip to content

Documentation improvements #14

@Sbozzolo

Description

@Sbozzolo

Here are suggestions to improve the documentation:

  • One of the selling features for GRBoondi is that only a handful of files are required to simulate new interesting Proca scenarios. However, how to set these new cases up is not explained. Maybe you could add a tutorial on how to add a new case? This is different from an example because it guides the user in the process and highlights the various components (e.g., how does one fill the params folder? What is the role of GNUmakefile?), as opposed to just having all the files in one place
  • See comment in [REVIEW]: GRBoondi: A code for evolving Generalized Proca theories on arbitrary backgrounds openjournals/joss-reviews#6888 (comment)
  • Not related to documentation, but why is csh required? It is a little odd requirement
  • I think it would be useful to document the typical computational requirements for a simulation. E.g., how much RAM, disk, CPUs for a reasonable simulation
  • Documentation on parameters is a little overwhelming. If some parameters are more important than others, I'd suggest highlighting those to increase the signal-to-noise ratio
  • The Home page of the documentation does not take me to the next step. It should be clear where to click next.
  • There are no contributor guidelines, e.g., code style, contribution workflow, testing requirements
  • There is no documentation on how to run tests
  • There are not many backlinks to GRChombo and Chombo.
  • If GRBoondi is not supposed to be used as a black box, how are user supposed to learn how the internals work? There is no documentation about this

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions