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

Rework documentation completely #364

Merged
merged 4 commits into from
Nov 9, 2022
Merged

Conversation

mwestphal
Copy link
Contributor

@mwestphal mwestphal commented Aug 22, 2022

TODO on merging this:

@mwestphal mwestphal marked this pull request as draft August 22, 2022 03:09
@mwestphal mwestphal requested a review from Meakk August 22, 2022 03:09
@mwestphal mwestphal force-pushed the jekyll_doc branch 2 times, most recently from 77c8c82 to c0870a3 Compare October 9, 2022 02:45
@mwestphal mwestphal marked this pull request as ready for review October 9, 2022 04:50
@mwestphal mwestphal changed the title Jekyll doc example Rework documentation completelly Oct 9, 2022
@CharlesGueunet
Copy link
Contributor

CharlesGueunet commented Oct 9, 2022

Ideas:

  • Add a menu / summary
  • Add a changelog entry with the changelog of the last relase
  • Add an icone in the tab of the browser
  • Use the space aside from the big f3d icon at the top

README.md Show resolved Hide resolved
doc/libf3d/OVERVIEW.md Outdated Show resolved Hide resolved
.gitattributes Outdated Show resolved Hide resolved
_config.yml Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
_config.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@mwestphal mwestphal force-pushed the jekyll_doc branch 3 times, most recently from ecd7079 to 1484c4e Compare October 23, 2022 03:14
GALLERY.md Outdated Show resolved Hide resolved
@Meakk
Copy link
Contributor

Meakk commented Oct 23, 2022

Comments on the website:

  • The link "F3D on github" on the top right isn't great. Can you maybe add a github logo and a better text like "Explore code source on GitHub"
  • The /fɛd/ text does not appear correctly on my mobile
  • Can we replace the animated gif on the home page with a video?
  • For the cpp examples, we should add #include <f3d/xxx.h>

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
_config.yml Show resolved Hide resolved
@mwestphal mwestphal force-pushed the jekyll_doc branch 3 times, most recently from 0036121 to 72e60b8 Compare November 6, 2022 09:59
.gitattributes Show resolved Hide resolved
GALLERY.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
doc/dev/TESTING.md Outdated Show resolved Hide resolved
doc/dev/TESTING.md Outdated Show resolved Hide resolved
doc/libf3d/OVERVIEW.md Show resolved Hide resolved
doc/libf3d/OVERVIEW.md Outdated Show resolved Hide resolved
doc/libf3d/OVERVIEW.md Show resolved Hide resolved
doc/dev/GENERATE.md Outdated Show resolved Hide resolved
doc/dev/GENERATE.md Outdated Show resolved Hide resolved
@mwestphal mwestphal requested a review from Meakk November 9, 2022 03:37
@mwestphal mwestphal force-pushed the jekyll_doc branch 2 times, most recently from 8cceff8 to af8bc95 Compare November 9, 2022 14:48
doc/dev/CODING_STYLE.md Outdated Show resolved Hide resolved
doc/dev/CODING_STYLE.md Outdated Show resolved Hide resolved
doc/dev/CODING_STYLE.md Outdated Show resolved Hide resolved
@Meakk Meakk changed the title Rework documentation completelly Rework documentation completely Nov 9, 2022
@mwestphal mwestphal merged commit 3e80540 into f3d-app:master Nov 9, 2022
@mwestphal mwestphal mentioned this pull request Nov 9, 2022
mwestphalnew pushed a commit to mwestphalnew/f3d that referenced this pull request Feb 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants