Skip to content

Conversation

@pierluc-codes
Copy link
Collaborator

@pierluc-codes pierluc-codes commented Nov 21, 2025

This PR generate.sh was not working because

# file: markdown/config/pandoc-defaults.yml
highlight-style: null

By specifying the value, the script is not working.

I fix some typo, see comments inline.

@ulysses4ever and me decidd to delete the generated files (markdown and html) since it is very confusing.

@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
"https://www.w3.org/TR/html4/strict.dtd">
<html lange="en">
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small typo

@@ -1,4 +1,5 @@
#!/bin/bash
#!/usr/bin/env bash
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hardcoding the path of bash will force this execution plan. If the environment is using a different bash it won't work. This line will use the first one on the PATH.

@@ -1,4 +1,5 @@
#!/bin/bash
#!/usr/bin/env bash
set -e
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will stop the script in case of failure.

@pierluc-codes pierluc-codes marked this pull request as ready for review November 21, 2025 01:33
@ulysses4ever
Copy link
Collaborator

I plan to review this over the weekend. Thanks!

@ulysses4ever
Copy link
Collaborator

ulysses4ever commented Nov 22, 2025

Could you please split configuration changes from textial changes in separate commits?

Fire textual changes, why do you only change generated files and not source files? I'd expect source files to be changed as well.

@pierluc-codes
Copy link
Collaborator Author

@ulysses4ever

Thanks for your feedback.

Fire textual changes, why do you only change generated files and not source files? I'd expect source files to be changed as well.

There was modification to source that didn't update the generate files. I didn't change the source file, so it was 'catch up' for what is already on main :) For instance: #67

I would love to automate that at one point, but as a a first step, contributors should be able to run the generate script would be great :)

For instance, this contribution didn't generate the docs: #92

@pierluc-codes pierluc-codes force-pushed the pierluc-codes/fix-generation-script branch from 9fca6e8 to 8d511ff Compare November 22, 2025 18:06
@pierluc-codes
Copy link
Collaborator Author

@ulysses4ever I split the changes into two commits as requested :)

ulysses4ever
ulysses4ever previously approved these changes Nov 23, 2025
Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, thank you!

So, Markdown already has these changes... Do you know anything about the top-level docs directory: does it have it or not? A random change that I tried to check (a mention of Haskell Discourse in Introduction) doesn't seem to be included in the version inside the docs. So, we have three slightly different versions (at times, at least). This is not a great place to be in. There should be some rationale documented somewhere (e.g. readme), as well as what path we would like to take from 3 versions to one.

@ulysses4ever
Copy link
Collaborator

After learning about the history of the markdown directory, I'm of the opinion that we should delete the markdown/generated_html directory, as it serves no purpose and only confuses people.

@pierluc-codes pierluc-codes force-pushed the pierluc-codes/fix-generation-script branch from dda8137 to 1c57549 Compare November 25, 2025 00:23
@pierluc-codes
Copy link
Collaborator Author

@ulysses4ever I think we can also delete generated_markdown. I went ahead and deleted both.

The repo is configured to dismiss review on changes, so you will have to re approve.

Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Could you please update the PR title and description with the summary of the actual changes?

@pierluc-codes pierluc-codes changed the title fix: generate.sh fix: generate.sh and delete generated files Nov 25, 2025
@pierluc-codes
Copy link
Collaborator Author

Thanks!

Could you please update the PR title and description with the summary of the actual changes?

Done!

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.

3 participants