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.

Sign up for GitHub

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

Jump to bottom

Improve documentation with regard to fix #25

Closed
TobiasNx opened this issue Aug 7, 2023 · 3 comments
Closed

Improve documentation with regard to fix #25

TobiasNx opened this issue Aug 7, 2023 · 3 comments
Assignees
@TobiasNx

Comments

@TobiasNx
Copy link
Collaborator

TobiasNx commented Aug 7, 2023 •
edited
Loading

We need to improve the documentation, that there are no distributed pages anymore.

@TobiasNx started in repo https://github.com/TobiasNx/metafacture_documentation_new.
We decided to merge these in a new branch in this repo and open a draft PR and review within the next week.

Review: @fsteeg , @dr0i and @katauber
@github-project-automation github-project-automation bot moved this to Backlog in Metafacture Aug 7, 2023
@TobiasNx TobiasNx moved this from Backlog to Working in Metafacture Aug 7, 2023
@TobiasNx TobiasNx self-assigned this Aug 7, 2023
TobiasNx added a commit that referenced this issue Aug 7, 2023
@TobiasNx
Add pages for new documentation #25
9b49eb1
@TobiasNx TobiasNx mentioned this issue Aug 7, 2023
Merged
@TobiasNx TobiasNx moved this from Working to Review in Metafacture Aug 28, 2023
@TobiasNx
Copy link
Collaborator Author

See #26

@TobiasNx TobiasNx removed their assignment Aug 28, 2023
TobiasNx added a commit that referenced this issue Sep 5, 2023
@TobiasNx @dr0i @fsteeg
Add pages for new documentation #25 (#26)
547edd8 
* Add pages for new documentation #25

* Update documentation

* Update Approaching a transformation with metafacture.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Approaching a transformation with metafacture.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Approaching a transformation with metafacture.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Approaching a transformation with metafacture.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Approaching a transformation with metafacture.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Home.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Home.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Home.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Getting-Started.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Flux-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Getting-Started.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Flux-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Framework-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Flux-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Flux-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Getting-Started.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Getting-Started.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update Flux-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Getting-Started.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Getting-Started.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Framework-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Getting-Started.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Framework-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Framework-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Framework-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Getting-Started.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update documentation pages

* Update Flux-User-Guide.md

Co-authored-by: Pascal Christoph <[email protected]>

* Update Fix-User-Guide.md

* Update Fix-User-Guide.md

* Update Fix-User-Guide.md

* Update Flux-User-Guide.md

Co-authored-by: Fabian Steeg <[email protected]>

* Update README.md

* Update README.md

* Update Getting-Started.md

* Update Fix-User-Guide.md

---------

Co-authored-by: Pascal Christoph <[email protected]>
Co-authored-by: Fabian Steeg <[email protected]>
@TobiasNx
Copy link
Collaborator Author

TobiasNx commented Sep 21, 2023 •
edited
Loading

We updated the pages. Now we should include them in the website somehow.

We should group the pages:
Metafacture

  • README.md
  • GettingStarted.md
  • Intro

Flux

  • User Guide
  • Commands

Fix

  • User Guide
  • Functions

Framework

  • User Guide

@TobiasNx
Copy link
Collaborator Author

TobiasNx commented Nov 7, 2023

The documentation is updated and additional material is added.
Next step would be to add a nice theme for the github page, see #28

Further improvements of the documentation will be done in new tickets

@TobiasNx TobiasNx closed this as completed Nov 7, 2023
@github-project-automation github-project-automation bot moved this from Review to Done in Metafacture Nov 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TobiasNx TobiasNx

Labels
None yet
Projects
Metafacture
Archived in project
Milestone
No milestone
Development

No branches or pull requests
1 participant
@TobiasNx