Skip to content

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

Merged
tlaurion merged 3 commits intolinuxboot:mainfrom
tlaurion:test
Nov 18, 2024
Merged

Fix "Edit on Github" links, improve local Jekyll testing guide and refer to flashkeeper.org in README.md#12
tlaurion merged 3 commits intolinuxboot:mainfrom
tlaurion:test

Conversation

@tlaurion
Copy link
Copy Markdown
Contributor

@tlaurion tlaurion commented Nov 18, 2024

  • 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!

- 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>
…nges" local Jekyll testing instructions

Signed-off-by: Thierry Laurion <insurgo@riseup.net>
Signed-off-by: Thierry Laurion <insurgo@riseup.net>
@tlaurion tlaurion merged commit 61801ef into linuxboot:main Nov 18, 2024
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.

1 participant