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

Improve doc theme and update README #4408

Merged
merged 8 commits into from
Dec 11, 2024
Merged

Conversation

bruhnild
Copy link
Contributor

@bruhnild bruhnild commented Dec 11, 2024

Description

Related Issue

Checklist

  • I have followed the guidelines in our Contributing document
  • My code respects the Definition of done available in the Development section of the documentation
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes
  • I added an entry in the changelog file
  • My commits are all using prefix convention (emoji + tag name) and references associated issues
  • I added a label to the PR corresponding to the perimeter of my contribution
  • The title of my PR mentionned the issue associated

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.46%. Comparing base (4c33d45) to head (ef41df0).
Report is 14 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4408   +/-   ##
=======================================
  Coverage   98.46%   98.46%           
=======================================
  Files         268      268           
  Lines       21290    21290           
=======================================
  Hits        20964    20964           
  Misses        326      326           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

cypress bot commented Dec 11, 2024

Geotrek-admin    Run #10577

Run Properties:  status check passed Passed #10577  •  git commit 8c4986361a ℹ️: Merge ef41df034a6fa3c4041ae7a09f9f089be7ec8526 into 875baeaea754c326376f00e9dd7e...
Project Geotrek-admin
Branch Review refs/pull/4408/merge
Run status status check passed Passed #10577
Run duration 02m 06s
Commit git commit 8c4986361a ℹ️: Merge ef41df034a6fa3c4041ae7a09f9f089be7ec8526 into 875baeaea754c326376f00e9dd7e...
Committer Marine Faucher
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 22
View all changes introduced in this branch ↗︎

@bruhnild bruhnild requested a review from submarcos December 11, 2024 09:41
@camillemonchicourt
Copy link
Member

Je passerai bien toute la doc de RST à MD partout.
Par contre commencer à mettre du HTML, je suis moins chaud, mais si c'est utile, pourquoi pas.

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
bruhnild and others added 6 commits December 11, 2024 11:54
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
Co-authored-by: Camille Monchicourt <[email protected]>
@bruhnild
Copy link
Contributor Author

Je passerai bien toute la doc de RST à MD partout. Par contre commencer à mettre du HTML, je suis moins chaud, mais si c'est utile, pourquoi pas.

J'ai effectué le remplacement du fichier README.rst par un fichier README.md

L'objectif de cette PR est d'harmoniser les readme entre les briques de Geotrek dans un souci de cohérence. J'ai donc repris la même structure que sur GTR ou GTW . Le HTML est utile pour la mise en page des titres et des badges.

@bruhnild bruhnild merged commit de3309e into master Dec 11, 2024
19 checks passed
@bruhnild bruhnild deleted the mfu-improve-docs-sphinx branch December 11, 2024 13:13
@submarcos submarcos changed the title 📝 [Documentation] Improve doc theme and update README Improve doc theme and update README Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants