Rust-GCC / Rust-GCC/Rust-GCC.github.io

Enable website to display status reports

Open
#6 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
10
Forks
11
PR merge metrics
No merged PRs in 30d

Description

  • Switch to workflow/CI based releases instead of branch-based
  • Figure out how to keep a submodule or equivalent to https://github.com/rust-gcc/reporting up to date
    • Probably by cloning the repo every-night and redeploying the website?
  • Figure out how to translate from org-mode to markdown or have github pages/jekyll display org-mode properly
    ---> This can be achieved by using the gfm export format for pandoc: pandoc --from=org --to=gfm <file>.org > <file>.md

For the last point, note that pandoc screws up the tables as well as some formatting like C++ code-blocks. So we still have some modifications to do (or maybe we can convert org-mode directly to HTML?)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the GitHub Pages/Jekyll setup and the rust-gcc/reporting repository, then compare the proposed workflow/CI release and nightly clone approaches. Check the pandoc org-to-gfm conversion, especially tables and C++ code blocks. Done means status reports are updated automatically and render correctly on the website.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll, markdown
Domain
build-system, ci-cd, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.