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

355 jana1 2 documentation side menu #359

Merged
merged 9 commits into from
Sep 11, 2024

Conversation

DraTeots
Copy link
Collaborator

  • Combine documents together and adds to a side menu. I played with how it is easier to conceive new addition in the menu and easier to navigate so that is why there are drastic changes.
  • Edited developers guide. Made it easier to read in editing mode as well as to properly highlight all c++ code.
  • Added documentation on how to manage and write the documentation. In particular how one can play with the site on a local machine.

I probably did something that hasn't been asked, please no offence here. But I just wanted to make it more accessible and easier to read.

@DraTeots DraTeots self-assigned this Sep 11, 2024
@DraTeots DraTeots linked an issue Sep 11, 2024 that may be closed by this pull request
@DraTeots
Copy link
Collaborator Author

I believe it makes #356 obsolete. I saw it too late. Sorry.

@DraTeots
Copy link
Collaborator Author

image
That is how it looks now (so you don't have to startup a local server)

@nathanwbrei
Copy link
Collaborator

While you are working on this, it looks like https://jeffersonlab.github.io/JANA2/#/tutorial is a broken link?

@DraTeots
Copy link
Collaborator Author

Ah... site deploys to github pages on each PR github actions run. That is not what we want. Fixed that. But the bright side is - you can see changes right now =)

But we WANT to merge this PR ASAP now.

@DraTeots
Copy link
Collaborator Author

While you are working on this, it looks like https://jeffersonlab.github.io/JANA2/#/tutorial is a broken link?

Fixed that. Worked on local machine because file system is case tolerant. It was Tutorial.md vs tutorial.md

@nathanwbrei
Copy link
Collaborator

If it makes your workflow faster, you can merge the documentation changes without waiting for all the other tests to complete

@DraTeots
Copy link
Collaborator Author

If it makes your workflow faster, you can merge the documentation changes without waiting for all the other tests to complete

I would prefer @RaiqaRasool to look at changes too. But I feel urgency to merge this PR to prevent security issue with any PR pushing changes to a website.

@DraTeots
Copy link
Collaborator Author

So, please, make another issue or PR if something is bad here.

@DraTeots DraTeots merged commit 8629fae into master Sep 11, 2024
9 checks passed
@DraTeots DraTeots deleted the 355-jana1-2-documentation-side-menu branch September 11, 2024 19:52
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.

JANA1-2 documentation side menu
2 participants