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.

Sign up for GitHub

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

Jump to bottom

feat: vitepress-docs #1617

Merged
merged 28 commits into from
Nov 28, 2023
Merged

feat: vitepress-docs #1617

merged 28 commits into from
Nov 28, 2023

Conversation

TheGreatRefrigerator
Copy link
Contributor

Pull Request Checklist

  • 1. I have rebased the latest version of the master branch into my feature branch and all conflicts
    have been resolved.
  • 2. I have added information about the change/addition to functionality to the CHANGELOG.md file under the
    [Unreleased] heading.
  • 9. I have referenced the Issue Number in the Pull Request (if the changes were from an issue).
  • 12. I have written in the Pull Request information about the changes made including their intended usage
    and why the change was needed.

Fixes #1528

Information about the changes

  • Key functionality added: VitePress GitHub-Pages documentaiton for /docs folder
  • Reason for change: Modern Design & easy dev-setup

@TheGreatRefrigerator TheGreatRefrigerator changed the title feat/vitepress-docs feat: vitepress-docs Nov 23, 2023
koebi and others added 20 commits November 23, 2023 13:46
@koebi @TheGreatRefrigerator
ci(docs): set up docs deployment via gh actions
0c889a1
@koebi @TheGreatRefrigerator
docs: remove TOC where present
b64ec65 
TOC is not needed due to outline feature in VitePress
@koebi @TheGreatRefrigerator
docs: fix dead links
c0f0844
@koebi @TheGreatRefrigerator
ci(docs): bump node version
a33c2b5
@koebi @TheGreatRefrigerator
docs: configure base URL for gh pages deployment
02e4336
@koebi @TheGreatRefrigerator
docs: configure footer
bd91cba
@koebi @TheGreatRefrigerator
docs: set up homepage & add getting started section
caf4427 
- move logo to correct place
@koebi @TheGreatRefrigerator
docs: set up custom styling
bba82bd
@TheGreatRefrigerator
docs: cleanup unused files
ede95f1
@koebi @TheGreatRefrigerator
docs: add search & edit nav
cb66759
@koebi @TheGreatRefrigerator
docs: use siteTitle to not show title in nav
e54d00e
@koebi @TheGreatRefrigerator
docs: finish sidebar
a8be605
@koebi @TheGreatRefrigerator
docs: remove remnants from vitepress init
2598231
@koebi @TheGreatRefrigerator
docs: remove redundant front-matter
85dac2a 
The title is inferred from the h1 heading,
which for most pages was the same as the title.
H1 was added if not present.
Kept front-matter for title FAQ, as it's a common abbreviation.
@koebi @TheGreatRefrigerator
docs: rename files to their titles
3d688f1
@TheGreatRefrigerator
docs: add dark theme logo
1632934
@TheGreatRefrigerator
docs: add last editted datetime
dd2401f
@TheGreatRefrigerator
docs: add link to improvement
bbfcd54
@TheGreatRefrigerator
docs: add favicon
ebf5a71
@TheGreatRefrigerator
docs: clean url setting
23f002f
@TheGreatRefrigerator
Copy link
Contributor Author

restructured commits a bit to remove "fixing" commits.

@koebi i removed running the 'build' also on 'preview' in package.json. If we want a combined task, we should add a dedicated one for it.

@koebi
Copy link
Collaborator

koebi commented Nov 23, 2023

We discussed this, and decided that preview should also always build.
There's rarely a situation where you don't want to preview your current state, and it's a bit counterintuitive that preview doesn't build…

koebi
koebi requested changes Nov 23, 2023
View reviewed changes
Copy link
Collaborator

@koebi koebi left a comment

Choose a reason for hiding this comment

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

Mentioned some minor points and two discussions:

  • tagline
  • trigger on what?

.github/workflows/deploy-docs.yml Show resolved Hide resolved
docs/index.md Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
docs/.vitepress/theme/custom.css Show resolved Hide resolved
@TheGreatRefrigerator
Copy link
Contributor Author

We discussed this, and decided that preview should also always build. There's rarely a situation where you don't want to preview your current state, and it's a bit counterintuitive that preview doesn't build…

it's just a bit off, as it then doesn't map 1:1 to the tasks that are run, which are currently the separate vitepress cli commands.
I would at least call the run task differently then e.g. just build-preview.
The not always wanting to run build could also be accomplished with having a run configuration for the preview task, that executes the build task before.
e.g.
grafik

If we have a combined npm task we can then also only name this in the Backend-Documentation.md

@github-actions github-actions bot added feature and removed feature labels Nov 24, 2023
@koebi
Copy link
Collaborator

koebi commented Nov 27, 2023

I think having an additional build-preview task is a good idea. Let's go with that :)

@TheGreatRefrigerator
Copy link
Contributor Author

I think having an additional build-preview task is a good idea. Let's go with that :)

added the combined task

@TheGreatRefrigerator TheGreatRefrigerator merged commit 5cd3d30 into master Nov 28, 2023
13 checks passed
@TheGreatRefrigerator TheGreatRefrigerator deleted the feat/vitepress-docs branch November 28, 2023 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@koebi koebi koebi approved these changes

@takb takb Awaiting requested review from takb

Assignees
No one assigned
Labels
feature
Projects
ors general
Status: Awaiting release
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

move to vitepress
2 participants
@TheGreatRefrigerator @koebi