search

riebl / artery

OMNeT++ V2X simulation framework for ETSI ITS-G5
GNU General Public License v2.0
202 stars 128 forks source link

Draft: Added section recommended literature to README.md #301

Closed Enough7 closed 11 months ago

Enough7 commented 11 months ago

I will probably add more soon. Is the README.md the right place for this? Maybe you want such information in a different place such as Artery's website.

TODO

riebl commented 11 months ago

I like this idea! As you have already announced that there will be more, adding it to a page on the Artery website might be better indeed. We could also add a subsection with articles using Artery there. In the README.md we can add a link to the webpage. Do you have experience with mkdocs which is the current website generator for Artery?

Enough7 commented 11 months ago

Do you have experience with mkdocs which is the current website generator for Artery?

I have experience with MarkDown. The website's repository is private, am I right? In general I have some experience in NodeJS and React, mainly using TypeScript.

As you have already announced that there will be more.

There will be more given that I will find more.

awillecke commented 11 months ago

I have experience with MarkDown. The website's repository is private, am I right? In general I have some experience in NodeJS and React, mainly using TypeScript.

I guess the website's sources are located in docs.

Enough7 commented 11 months ago

I guess the website's sources are located in docs.

I see, I see, thank you

Enough7 commented 11 months ago

I added on how to build the Website and added a pyproject.toml for easy install. Also I can not syntaxhighlighting using codehilite with pygments to run. Any ideas on this?

Enough7 commented 11 months ago

Fixed path issue. Also the docs/asset/vagrant.webm has for some reason no header. I am not sure if I broke it or it broke somehow else.

Enough7 commented 11 months ago

The Doxygen Docs could also be integrated into the website, don't you think?

Enough7 commented 11 months ago

Also the docs/asset/vagrant.webm has for some reason no header. I am not sure if I broke it or it broke somehow else.

The logo.png seem broken as well, for some reason? image

Enough7 commented 11 months ago

Request for feedback

Optional darkmode (uses User System Settings, can be switch manually in the header): Optional darkmode

Added Syntaxhighlighting and line numbers: image

Also made some changes to 'Work with VS Code' page.

I suggest you to start at the docs/website/README.md,

Enough7 commented 11 months ago

Any ideas on why theme.palette only works with two spaces indention and does not work with four spaces indention? See mkdocs.yml Line 9-31

Enough7 commented 11 months ago

Next step could be

Enough7 commented 11 months ago

@riebl @awillecke Whats your opinion on my changes?

riebl commented 11 months ago

Oops, I have added review comments but forgot to submit my review a few days ago…

riebl commented 11 months ago

Hi @Enough7, I picked most of your commits from this draft PR into the master branch. I think I have only omitted the VSCode YAML schema for now. Please feel free to put this schema file in a new PR; a short info about this file and its purpose in docs/mkdocs.yml would be nice too! Thanks a lot for your hard work so far!

PS: I cannot merge PRs that are marked as "draft", thus I had to pick your commits locally.

Enough7 commented 11 months ago

Hi @riebl, I just saw the homepage and it looks really great I think.

I cannot merge PRs that are marked as "draft", thus I had to pick your commits locally.

Ohh thank you for letting me know. I did not know that. In GitLab it is usually the prefix Draft: which needs to be removed from the tittle in order to merge. I am more used to GitLab than to GitHub.

Also I am quite thankful for the merge. I have really a lot of pull request stacked up which never got merged :(

Enough7 commented 11 months ago

Hi @riebl, I just want to add the following for your information.