Skip to content

Fix "Edit on Github" links, improve local Jekyll testing guide and refer to flashkeeper.org in README.md #12

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
Merged
merged 3 commits into from
Nov 18, 2024
Merged

Fix "Edit on Github" links, improve local Jekyll testing guide and refer to flashkeeper.org in README.md #12

merged 3 commits into from
Nov 18, 2024

Conversation

tlaurion
Copy link
Contributor

@tlaurion tlaurion commented Nov 18, 2024 •
edited
Loading

  • Fixes 'Edit this page on github' footer: URLs were missing '/docs' in their paths.
  • Adds a docs/_config-local.yml to be used for local iterations of documentation rendering prior of pushing future PR.
  • Improves Contrib docs for "big changes", referring to Jekyl usage of _config-local.yml for local docs iteration prior of PR.
  • Have README.md point to https://flashkeeper.org where /docs is rendered by github pages for each commit of this monorepo (so that docs can improve with code in single commit/PR).

We have a base!

@tlaurion
fix "Edit this page on Github" links in footer of rendered pages
0a577fd 
- Add docs/_config-local.yml to be used with 'jekyll serve --config docs/_config-local.yml --incremental'
- Modifies image path under docs/index.md
- docs/_config.yml should be used solely by github pages

Signed-off-by: Thierry Laurion <insurgo@riseup.net>
@tlaurion
docs/Development/Contributing-to-Flashkeeper-Wiki.md: modify "big cha…
ced2b6f 
…nges" local Jekyll testing instructions

Signed-off-by: Thierry Laurion <insurgo@riseup.net>
@tlaurion
README.md: point to https://flashkeeper.org for rendered documentation
faa27e8 
Signed-off-by: Thierry Laurion <insurgo@riseup.net>
@tlaurion tlaurion merged commit 61801ef into linuxboot:main Nov 18, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@tlaurion