Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize documentation #199

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

josebailo
Copy link
Contributor

Following the issue #176, I've tried to add a little bit of documentation and separate the basic documentation from the documentation more focused for developers:

  • Added new markdown file in the doc folder with the Developer's guide. Here is included the more technical information with a little bit of documentation on how the fractal and the program work. This could be a beginning to continue extending the information. My first idea was integrate the developer's guide in the manual, maybe as a separate section or even within a new manual, but I didn't find how to create a second manual with hugo without duplicating all the structure and the git submodule. Maybe we could find another tool for the manual...
  • The README has change to simplify it.
  • Updated to the last version of hugo.
  • Added new sections in the manual, installation and FAQ (from the FAQ of the wiki).

@codecov
Copy link

codecov bot commented Dec 22, 2020

Codecov Report

Merging #199 (e2e3a68) into master (5749f1b) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #199   +/-   ##
=======================================
  Coverage   81.38%   81.38%           
=======================================
  Files          55       55           
  Lines       10868    10868           
=======================================
  Hits         8845     8845           
  Misses       2023     2023           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5749f1b...b013fac. Read the comment docs.

@da2ce7 da2ce7 added the needs rebase This pull request needs to be rebased before being merged. label Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs rebase This pull request needs to be rebased before being merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants