Skip to content

90 add documentation #173

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
Merged
JavierCladellas merged 55 commits into from
Dec 10, 2024
Merged

90 add documentation #173

JavierCladellas merged 55 commits into from
Dec 10, 2024

Conversation

@JavierCladellas
Copy link
Collaborator

@JavierCladellas JavierCladellas commented Dec 2, 2024 •
edited
Loading

Done:

  • Wrote a first version of user documentation
  • Fixed a minor bug (typo in a parameter)
  • Updated local config
  • Made some configuration fields optional

@JavierCladellas
start doc #90
5a3ca6f
@JavierCladellas
Merge branch 'master' into 90-add-documentation
e7b2022
@JavierCladellas
Merge branch '139-add-integration-tests-for-ci' into 90-add-documenta…
142a185 
…tion
@JavierCladellas
start quickstart #90
3ae7e5e
@JavierCladellas
Merge remote-tracking branch 'origin/158-remove-launch-options-from-m…
f9a13be 
…achine-config' into 90-add-documentation
@JavierCladellas
up local config
a619c0e
@JavierCladellas
add local config
92bd14c
@JavierCladellas
dont use pwd
009383d
@JavierCladellas
up test app
5c79185
@JavierCladellas
up config (lower cores)
9352822
@JavierCladellas
start config guide #90
121e79f
@JavierCladellas
add docs as module #90
7aeddc6
@JavierCladellas
small doc fix #90
03b5986
@JavierCladellas
Merge branch '139-add-integration-tests-for-ci' into 90-add-documenta…
f7d4351 
…tion
@JavierCladellas
Merge branch '139-add-integration-tests-for-ci' into 90-add-documenta…
9b528dd 
…tion
@JavierCladellas
rm nav
b8e438e
@JavierCladellas
split docs
355578a
@JavierCladellas
Merge branch 'master' into 90-add-documentation
c86ceb8
@JavierCladellas
rename
0b5c0aa
@JavierCladellas
some tweaks #90
563cea3
@JavierCladellas
make exec_policy optioanl (default serial)
f433df9
@JavierCladellas
split configs and wrote machine config doc #90
ec2b230
@JavierCladellas
input_dataset_base_dir is now optional
a249721
@JavierCladellas
add note and init bench config #90
23a3502
@JavierCladellas
up local and set env default
cfc4aa7
@JavierCladellas
lower tasks
d56d5e3
@JavierCladellas
fix python 3.8
409be7f
@JavierCladellas
fix dirs
c1b08b4
@JavierCladellas
up exe local
106dc9d
@JavierCladellas
add comments
2686d4e
@JavierCladellas JavierCladellas linked an issue Dec 2, 2024 that may be closed by this pull request
Add documentation #90
Closed
5 tasks
@JavierCladellas JavierCladellas self-assigned this Dec 2, 2024
@netlify
Copy link

netlify bot commented Dec 2, 2024 •
edited
Loading

✅ Deploy Preview for benchmarking-polite-crostata-92f389 ready!

Name Link
🔨 Latest commit 0492b8d
🔍 Latest deploy log https://app.netlify.com/sites/benchmarking-polite-crostata-92f389/deploys/674f212848b64c00083793cc
😎 Deploy Preview https://deploy-preview-173--benchmarking-polite-crostata-92f389.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@JavierCladellas JavierCladellas added documentation Issues related to documentation enhancement A new feature or request labels Dec 3, 2024
@JavierCladellas JavierCladellas marked this pull request as ready for review December 3, 2024 10:51
@JavierCladellas JavierCladellas merged commit a039eae into master Dec 10, 2024
10 checks passed
@JavierCladellas JavierCladellas deleted the 90-add-documentation branch December 10, 2024 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@prudhomm prudhomm prudhomm approved these changes

@vincentchabannes vincentchabannes Awaiting requested review from vincentchabannes

Assignees

@JavierCladellas JavierCladellas

Labels

documentation Issues related to documentation enhancement A new feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add documentation

3 participants

@JavierCladellas @prudhomm