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

Port documentation from html to markdown #564

Merged
merged 16 commits into from
Aug 12, 2024

Commits on Jul 30, 2024

  1. Port docs to md rendered to html by Github Pages.

    Use https://just-the-docs.com/ template. And setup Home page.
    
    Need to use custom deployment workflow to be able to use docs/
    as source, which is slightly inconvenient compared to other themes
    but might allow more customisation later.
    
    The benefit of deploying docs is that the main/landing page will
    display automatically when clicking on docs in Github. Then navigation
    is straightforward.
    blapie committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    7aed439 View commit details
    Browse the repository at this point in the history
  2. Move sections to dedicated folders and convert landing page

    Sections' landing pages are now rendered in github (section/README.md)
    and on website (section/index.html).
    
    Providing the pages permalink will make links to other pages
    work in both Github and website.
    Note the / matters at the end of the permalinks it allows to maintain
    directory structure (in presence of parent/child sections) or not,
    
    Fix tables of content.
    
    Links to images and test files, and old html content will break,
    it is fixed in following commits.
    blapie committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    9cf38ab View commit details
    Browse the repository at this point in the history
  3. Cleanup: Move images to img/ and sources to src/

    This breaks all the links, therefore needs to be fixed in following commits.
    blapie committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    b8b76fc View commit details
    Browse the repository at this point in the history
  4. Fix links to images

    Need to use relative link to be able to render in both github and website,
    absolute link can only work in both cases if root is deployed (instead of docs/).
    
    Convert some html to markdown for picture, downside is resizing impossible in md.
    blapie committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    ef9fbec View commit details
    Browse the repository at this point in the history
  5. Fix links to source files

    Need to use relative link to be able to render in both github and website.
    Other option would be to have a dedicated src/ in each section.
    blapie committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    c416ca6 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    b9759a3 View commit details
    Browse the repository at this point in the history
  7. Fix all internal links

    More than just changing the path.
    For github rendering we need to
    - not refer to html files
    - use relative path since absolute path changes between website and github
    - permalinks ensure a similar file structure
    
    A solution to these issues would be to deploy the root of sleef,
    this would have the benefit of not needing a workflow and a Gemfile.
    blapie committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    4d8c311 View commit details
    Browse the repository at this point in the history
  8. Cosmetical changes

    Improve/Fix tables.
    Simplify logo (rename and get rid of old ones).
    blapie committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    c0c1b57 View commit details
    Browse the repository at this point in the history
  9. Port most content to markdown

    Use ``` for code and command sections.
    Remove <p></p> when no alignement is needed.
    Reformat links using markdown
    
    Following stuff is left for later
    
    - Not sure what to do about titles, github does not allow
      short labels, so we would need to change the links to long titles.
    - Cannot autogen TOC because headers need to be in html to allow for custom labels
    blapie committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    23d761c View commit details
    Browse the repository at this point in the history
  10. Configuration menu
    Copy the full SHA
    d009666 View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    06a92b4 View commit details
    Browse the repository at this point in the history
  12. Configuration menu
    Copy the full SHA
    5e8df69 View commit details
    Browse the repository at this point in the history
  13. Resize appearing in tables.

    Rename most logos.
    blapie committed Jul 30, 2024
    Configuration menu
    Copy the full SHA
    964a0e0 View commit details
    Browse the repository at this point in the history

Commits on Aug 9, 2024

  1. Configuration menu
    Copy the full SHA
    5ccfcc3 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    c05de91 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    1bc1ff7 View commit details
    Browse the repository at this point in the history