Skip to content

Conversation

@giovanni-vaccarino
Copy link
Contributor

Description

This PR fixes #12, by reorganizing the documentation under docs/ in many .md files, instead of a single bloated README.md. In particular the directory structure inside docs/ mirrors the codebase structure. A setup.md have been added to handle the installation guides for both Linux and Windows OSs. The README.md now contains only the basic information about the documentation, explains how to run the basic flows using the targets of the Makefile, and refer to other documentation files for further details.

Submitter checklist

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira

@giovanni-vaccarino
Copy link
Contributor Author

giovanni-vaccarino commented Jul 15, 2025

@berviantoleo I've included a new workflow for windows, as you suggested in #12. Should I also run the backend tests in that workflow, or its purpose is only to verify the installation with requirements-cpu.txt?

@berviantoleo
Copy link
Contributor

@berviantoleo I've included a new workflow for windows, as you suggested in #12. Should I also run the backend tests in that workflow, or its purpose is only to verify the installation with requirements-cpu.txt?

I don't think we need that for backend tests. Just for verifying the requirements file.

@giovanni-vaccarino giovanni-vaccarino marked this pull request as ready for review July 15, 2025 12:34
@giovanni-vaccarino giovanni-vaccarino requested a review from a team as a code owner July 15, 2025 12:34
@krisstern krisstern requested review from cnu1812 and krisstern July 15, 2025 15:38
@cnu1812 cnu1812 merged commit fc1e336 into jenkinsci:main Jul 16, 2025
22 checks passed
@giovanni-vaccarino giovanni-vaccarino deleted the refactor-documentation branch July 16, 2025 10:26
@berviantoleo berviantoleo added the documentation Improvements or additions to documentation label Aug 18, 2025
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.

Improve Developer Documentation Structure

5 participants