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

Documentation #12

Merged
merged 6 commits into from
Oct 12, 2024
Merged

Documentation #12

merged 6 commits into from
Oct 12, 2024

Conversation

pixup1
Copy link
Member

@pixup1 pixup1 commented Jun 16, 2024

Description

This PR adds documentation base files in the form of an mdbook similar to the one in the website backend, using release tags to compile the mdbook to html with github Actions.

If this is merged, we need to add the following line to mappings.txt in the infra-insalan.fr repo:

https://github.com/InsaLan/langate3000/releases/latest/download/manuel.tar.gz /srv/http/docs/langate

The deploy_docs.sh script should copy the docs to docs.insalan.fr periodically.

Structure and content of the documentation is mostly placeholder.

Checklist

  • [N/A] I have tested the changes locally and they work as expected.
  • [N/A] I have tested the responsiveness of the changes and they work as expected.
  • I have assigned the pull request to the appropriate reviewer(s).
  • I have added labels to the pull request, if necessary.

Related Issues

Fix #9

@pixup1 pixup1 added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 16, 2024
@pixup1 pixup1 self-assigned this Jun 16, 2024
@pixup1 pixup1 linked an issue Jun 16, 2024 that may be closed by this pull request
4 tasks
@pixup1 pixup1 removed the enhancement New feature or request label Jun 16, 2024
@pixup1 pixup1 requested a review from KwikKill June 16, 2024 16:18
@pixup1 pixup1 marked this pull request as ready for review June 16, 2024 16:18
Copy link
Member

@KwikKill KwikKill left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good start for documentation, LGTM !

@@ -0,0 +1,3 @@
# Style

Le thème de la langate est réalisé en CSS.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One line, one error 😉
The front is made with tailwind without css classes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

umm... it's placeholder anyway 😃👍

Copy link

@Ecnama Ecnama left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, ig

@pixup1 pixup1 merged commit fed329e into dev Oct 12, 2024
2 checks passed
@pixup1 pixup1 deleted the doc branch October 13, 2024 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation
3 participants