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

docs: Move the docs and toturial directories to the root #7518

Closed
wants to merge 1 commit into from

Conversation

mnonnenmacher
Copy link
Member

Move the docs and tutorial directories from the docusaurus directory to the root of the repository to make them easier to discover when looking at the repository.

Move the docs and tutorial directories from the docusaurus directory to
the root of the repository to make them easier to discover when looking
at the repository.

Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.io>
@mnonnenmacher
Copy link
Member Author

@tsteenbe This moves the docs and tutorial directories to the root. Regarding the renaming of the docusaurus directory I'd like some other opinions, e.g. from @sschuberth or @fviernau. For me "website" would be fine but I'm open to suggestions.

@codecov
Copy link

codecov bot commented Sep 15, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (dc6d4a9) 68.02% compared to head (9f5f9f0) 68.02%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #7518   +/-   ##
=========================================
  Coverage     68.02%   68.02%           
  Complexity     2023     2023           
=========================================
  Files           343      343           
  Lines         16723    16723           
  Branches       2371     2371           
=========================================
  Hits          11375    11375           
  Misses         4364     4364           
  Partials        984      984           
Flag Coverage Δ
funTest-docker 69.40% <ø> (ø)
funTest-non-docker 36.46% <ø> (ø)
test 35.51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sschuberth
Copy link
Member

For me "website" would be fine but I'm open to suggestions.

What I don't like so much about "website" is that IIUC the directory doesn't really contain the (generated) website, but the code of the framework to generate it. In that sense "docusaurus" was IMO more fitting. But I do not care all too strong either way.

@sschuberth
Copy link
Member

Commit message typo in "toturial".

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.

2 participants