acid-info / logos-site-builder Goto Github PK

We should align all items on same level where the search bar stays.

• increasing the line-height
• removing space from h elements when they are the first line of the main content

When doing content changes on one of the Waku websites, I want to be able to preview the generated websites before I merge the PR.

The reason why is:

• Checking that all links work as expected.
• Checking that the content organization make sense when looking at the ToC
• Confirming that code formatting is alright, especially for some tricky formats such as JSON
• Confirming that page size and density looks ok for the target audience, if too heavy, I would reduce content or split pages
• Checking rendering of any custom html I may include
• etc

In terms of solution, either:

• being able to easily deploy the website locally
• or having preview for each PR
  Would be acceptable.

• code snippets not highlighting all matches. An example search query on logos.co site what

Checking https://staging.waku.org/

HTML Comments <!-- --> are not hidden (they usually are when content is generated from MarkDown).

Surprisingly there is no easy webhook-like solution for this. And hence we have a couple of expensive options as follows;

1. Use built-in integration of Vercel such as deploy-summary! The downside of this is the fact that this app requires lots of (non-sense) permissions to be granted. Full read and write access to all public and private GitHub repos.

2. Build our own webhook integration and then link hook it into our logs channel on Discord.

The footer text (cc) should come from the config file.

So this would make the folder names in the sitemap clickable in a way that navigates you to the root path of the folder and it can render a list of links to its subpages.

• the left menu and ToC are not scrollable if the page content is longer than the menu/ToC itself. For example https://staging.vac.dev/research/2019-07-19-p2p-data-sync-for-mobile
  you cannot scroll the left menu if you dont' arrive at the end of the page content. Same for https://staging.vac.dev/research/2019-11-08-feasibility-semaphore-rate-limiting-zksnarks#proof-time
  ToC.

https://cdn.discordapp.com/attachments/975616666199261284/983447884089405481/Screenshot_2022-06-06_at_21.02.24.png

• mermaid
  https://ivanceras.github.io/svgbob-editor/

The social icons in the footer are tiny weeny. Not sure reader will easily find them.

Check the giant icons at https://wakuconnect.dev/ (around the bottom).

I have added some social links in the side bar manually for waku.org

I wonder if there is a better way. Maybe it can be tiny weeny in the footer but there is some way to select a few with an icon in the sidebar?

This should be search "title" of the website!

Problem

I noticed some links on waku.org were invalid:

md file:

[Learn more about Waku](/docs/index.md)

Link rendered by acid-info:

https://waku.org/docs/index.md

I understand the correct markdown content is:

[Learn more about Waku](/docs/index)

But it seems counter-intuitive and an easy pitfall because when working in MarkDown my editor (or is it only me) expect local path to existing files (ie index.md and not index).

Propose solution

Have the framework automatically remove .md on local paths.

Note

The config.json file expect the .md extensions:

  "navigation": {
    "home": "main.md",
    "fileOrdersInSidenav": [
      "main.md",
      "about.md",
      "platform.md",
      "operator.md",
      "contribute.md"
    ],

• Add dynamic mechanism, reading it from config file

When clicking on the burger menu top left.

Expected: side bar disappears, middle column's width increase so that it becomes more readable on narrow screen

Actual: side bar text is replace with blank space

if in the search bar you digit ? + any characters you receive the error message "Application error: a client-side exception has occurred (see the browser console for more information).

We need to add an option that enables us to sort the links inside the sidebar based on dates. This should be used probably as default and then gets overwritten by navigation.fileOrdersInSidenav & navigation.folderOrdersInSidenav in config file.

Some thoughts
This can happen inside TreeNodeMarkdown inside attachMetadata method. Here we can fetch metadata from Github or Notion and attach it to the node.

At https://github.com/acid-info/waku.org/commit/966876232c3baa2e467f06d4a4640eda987d5fe5

We can see "..." under "Contribute to Waku" but nothing happens when clicking on the dots.
Also, not sure what would be expected as the contribute.md is the last file in fileOrdersInSidenav.

https://github.com/acid-info/waku.org/issues/6

https://cdn.discordapp.com/attachments/975616666199261284/983378724189782056/unknown.png

When setting the following in config.json:

     {
        "provider": "telegram",
        "handler": "waku_org"
      }

Expected:

Telegram link https://t.me/waku_org is rendered.

Actual:

No link

• Code blocks by default get the general theme coloring and by hover switch to highlightjs css

We need a mechanism that enables the user to define a list of external repos(folders) and they become embedded within their site as well.

Here
https://staging.logos.co/territory

I have a file with the following path: docs/main/choose_content_topic

In another file, I added a link to this file: /docs/main/choose_content_topic.

However, this returns a 404. I can see that I need to use /docs/main/choose-content-topic to access the file (hyphens instead of underscores).

Expected: path to files are not changed by the framework

Vac and Status are using Discourse for forum software.

See bottom of https://wakuconnect.dev/

When setting the following in social_media:

      {
        "provider": "discourse",
        "handler": "forum.vac.dev"
      }

Expected: Discourse icon in the footer that links to https://forum.vac.dev/
Actual: no rendering

When omitting the category property of external_links:

Expected:

The links are rendered with the same indentation than the pages set in fileOrdersInSidenav.

Actual:

Links are indented under an undefined category

Add possibility to use permalink in front-matter if present to define page path