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

Add website #50

Merged
merged 7 commits into from
Oct 11, 2024
Merged

Add website #50

merged 7 commits into from
Oct 11, 2024

Conversation

orzechow
Copy link
Member

@orzechow orzechow commented Sep 23, 2024

This closes #33

image

@orzechow orzechow marked this pull request as ready for review October 7, 2024 15:42
@orzechow
Copy link
Member Author

orzechow commented Oct 7, 2024

@ll-nick Ready for review and merging.

We should change the GitHub Pages branch setting to main after merging.

Copy link
Collaborator

@ll-nick ll-nick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good and the docker setup works (almost) like a charm, thank you! 🚀
Also very nice work in keeping the root directory clean. 🧹

Maybe you have an idea for these two things, otherwise feel free to merge :)

  1. The browser tab title is currently: ARBITRATION_GRAPHS | Arbitration Graphs
    I tried changing it using a title: in the _config.yml but that only affects the second half. I did not manage to change the first half. I would imagine it being either only Arbitration Graphs or something like Arbitration Graphs | Home since we want to have different pages.
  2. About the docker setup: I did not manage to get it to work at first because my root directory contained the compile_commands.json. Since that is a symlink generated in the dev container, it points to something like /home/blinky which is apparently something jekyll is not able not handle, even if you add it to the exclude: setting. I solved it by removing the link, not sure if there is a better option.

README.md Show resolved Hide resolved
Comment on lines +1 to +8
# This is a config file for Jekyll, the static site generator used by GitHub Pages.
#
# In our setup, the top-level README.md is the landing page,
# while the rest of the pages and all assets are in the docs folder.
#
# This way, we can use the main branchs' README.md as main website,
# add subpages for the tutorial and deep dive docs,
# while avoiding Jekyll clutter in the repo root.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

@ll-nick
Copy link
Collaborator

ll-nick commented Oct 8, 2024

Oh and once we solved #49, we should definitely add a favicon 😉

@orzechow
Copy link
Member Author

orzechow commented Oct 11, 2024

1. The browser tab title is currently: `ARBITRATION_GRAPHS | Arbitration Graphs`
   I tried changing it using a `title:` in the `_config.yml` but that only affects the second half. I did not manage to change the first half. I would imagine it being either only `Arbitration Graphs` or something like `Arbitration Graphs | Home`  since we want to have different pages.

Done, see ad495ac

2. About the docker setup: I did not manage to get it to work at first because my root directory contained the compile_commands.json. Since that is a symlink generated in the dev container, it points to something like `/home/blinky` which is apparently something jekyll is not able not handle, even if you add it to the `exclude:` setting. I solved it by removing the link, not sure if there is a better option.

I don't know how you've setup your dev container. But when using our docker compose setups, the compile_commands.json should be generated into the build folder and shouldn't be a symlink.

Maybe, you had issues with the demo build setup.
You can tell your cmake to lookout for demo/build instead of build. In VSCode that's sth like
"cmake.buildDirectory": "${workspaceFolder}/demo/build"
neovim will have sth similar.
The, you won't need the symlink workaround

@orzechow orzechow merged commit a951150 into main Oct 11, 2024
3 checks passed
@orzechow orzechow deleted the add_website branch October 11, 2024 14:38
@ll-nick
Copy link
Collaborator

ll-nick commented Oct 11, 2024

Yeah, nevermind the compile commands thing. I am honestly not sure why the link was even there in the first place, my LSP works just fine without it 🤷‍♂️

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.

Add project website
2 participants