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

Cleaning up the documentation #2238

Closed
8 of 11 tasks
ttusar opened this issue Nov 10, 2023 · 1 comment
Closed
8 of 11 tasks

Cleaning up the documentation #2238

ttusar opened this issue Nov 10, 2023 · 1 comment
Assignees
@olafmersmann

Comments

@ttusar
Copy link
Contributor

ttusar commented Nov 10, 2023 •
edited by olafmersmann
Loading

Mentions of do.py need to be updated with new instructions in the following files:

  • README.md
  • code-experiments/README.md
  • code-experiments/build/README.md
  • code-experiments/build/python/README.md
  • code-experiments/examples/bbob-biobj-matlab-smsemoa/README.md
  • code-experiments/test/unit-test/README.md
  • code-postprocessing/aRTAplots/generate_aRTA_plot.py
  • code-postprocessing/build/lib/cocopp/test.py
  • code-postprocessing/cocopp/test.py
  • scripts/fabricate
  • howtos/different-dimensions-howto.md
olafmersmann added a commit that referenced this issue Nov 17, 2023
@olafmersmann
[doc] Add developer documentation
1d411b6 
Since switching away from do.yp to scripts/fabricate, the developer
experience has changed drastically. This commit starts adding more
formal documentation on how a developer interacts with the code
base.

Resolves #2230
Partially fixes #2238
olafmersmann added a commit that referenced this issue Nov 17, 2023
@olafmersmann
[doc] Add developer documentation
81eabdf 
Since switching away from do.yp to scripts/fabricate, the developer
experience has changed drastically. This commit starts adding more
formal documentation on how a developer interacts with the code
base.

Resolves #2230
Partially fixes #2238
olafmersmann added a commit that referenced this issue Nov 17, 2023
@olafmersmann
[doc] Add developer documentation
51ae3bf 
Since switching away from do.yp to scripts/fabricate, the developer
experience has changed drastically. This commit starts adding more
formal documentation on how a developer interacts with the code
base.

Resolves #2230
Partially fixes #2238
olafmersmann added a commit that referenced this issue Nov 17, 2023
@olafmersmann
[doc] Add developer documentation
0722533 
Since switching away from do.yp to scripts/fabricate, the developer
experience has changed drastically. This commit starts adding more
formal documentation on how a developer interacts with the code
base.

Resolves #2230
Partially fixes #2238
@olafmersmann
Copy link
Contributor

I added a DEVELOPMENT.md file to the root directory of the repository that contains all the info collected in #2230. There's still quite a bit of cruft in the root README.md, but I'm not sure how much we need to keep and how much should be migrated to the new website. Putting as much information on the website as possible means people will have less of a need to interact with the repository -- which I think is a net positive.

lorenzo-consoli pushed a commit that referenced this issue Nov 22, 2023
@olafmersmann @lorenzo-consoli
[doc] Add developer documentation
4eae0d9 
Since switching away from do.yp to scripts/fabricate, the developer
experience has changed drastically. This commit starts adding more
formal documentation on how a developer interacts with the code
base.

Resolves #2230
Partially fixes #2238
lorenzo-consoli pushed a commit that referenced this issue Nov 25, 2023
@olafmersmann @lorenzo-consoli
[doc] Add developer documentation
fb03736 
Since switching away from do.yp to scripts/fabricate, the developer
experience has changed drastically. This commit starts adding more
formal documentation on how a developer interacts with the code
base.

Resolves #2230
Partially fixes #2238
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@olafmersmann olafmersmann

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@olafmersmann @ttusar