search

parkouss / webmacs

webmacs - keyboard driven (emacs key bindings) browser, https://webmacs.readthedocs.io/en/latest/
GNU General Public License v3.0
156 stars 21 forks source link

Doc #89

Closed jbmestelan closed 6 years ago

jbmestelan commented 6 years ago

Hello.

Here are a few suggestions for improving the documentation. The documentation is globally very well written; I have only added minor syntax corrections (mainly added or removed 's' occurrences), and capitalizations (emacs -> Emacs ; javascript -> JavaScript; an url -> a URL). Lastly, a few linguistic changes which, I suppose, are debatable; feel free to integrate them or not, I will be happy to discuss them.

I hope the changes do not break anything; I have been unable to regenerate the documentation (on Debian stable).

cd docs
make html
Running Sphinx v1.4.9

Extension error:
Could not import extension webmacs_sphinx_ext (exception: No module named '_adblock')
Makefile:20: recipe for target 'html' failed
make: *** [html] Error 1
parkouss commented 6 years ago

Ah, yeah building the doc currently requires to set the env var READTHEDOCS=1. This is an issue that should be fixed, sorry for this.

Thanks so much for doing this! I know I make mistakes writing English so I highly appreciate the help here. Looking more deeply right now.

parkouss commented 6 years ago

Awesome, that's really cool you reviewed all this. I really appreciate it. I will generate the doc locally this week end and review it a final time then merge this.