How to contribute to the documentation?

1

Hi! I’ve been trying to pick up FEniCS by going through the tutorials.

However, going through https://fenicsproject.org/pub/tutorial/sphinx1/._ftut1003.html#the-complete-program, I ran into an error at the last line - the interactive() call. I looked around, it turned out to be deprecated, which sounds like a reasonable decision. All right! But I figured I could probably make this easier for the next person figuring FEniCS out and remove that line, possibly replacing it with a Matplotlib plot.

The documentation seems like it’s in a pretty disjointed state, though:

  • https://bitbucket.org/fenics-project/docs seems like it mostly describes the API side of things, without the tutorials
  • fenics-project/fenics-book/ hasn’t been updated since 2013 (and just the README, at that), which is fine since the printed book isn’t going to update itself;
  • The fenics-project/fenics-web/ repository raises my hopes but turns out to be deprecated and the site is now maintained via Wordpress!

My question, thus, is: is there currently any way to contribute to the public-facing documentation?

2

Hi Dominik, I am also in a situation similar to you. Maybe you want to comment in my post:

The FEniCS Book and non-automatically generated documentation for the 2019 version of FEniCS?

3

You might try asking about this on the Slack channel; that’s where most of the discussion about potential project contributions occurs. (E.g., some of the recent discussion there is on translating documentation into Spanish.)