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

Review Reken.dev and supporting documents #19

Open
hbroek opened this issue Jun 23, 2023 · 4 comments
Open

Review Reken.dev and supporting documents #19

hbroek opened this issue Jun 23, 2023 · 4 comments

Comments

@hbroek
Copy link
Owner

hbroek commented Jun 23, 2023

The Reken.dev website and various documents need a 2nd set of eyes to look for typos, grammar etc. English being my 2nd language is my excuse.

@hbroek
Copy link
Owner Author

hbroek commented Jun 23, 2023

@freshgum-bubbles, perhaps you want to give this a shot.

@freshgum-bubbles
Copy link
Contributor

freshgum-bubbles commented Jun 25, 2023

@freshgum-bubbles, perhaps you want to give this a shot.

Happy to give it a look :-)

(apologies for the edit)

As an initial suggestion, it looks like the index.html file is directly in the root of the project.
This intermingles it with various configuration files, sources, and more, which makes it a bit confusing.
(Also, the assets folder for said website is also in the root.)

Normally, the best practice is to put all the website code under the docs/ folder, which (IIRC)
GitHub Pages does support. Should this be changed?


Anyway, aside from that, I'll have a look through and see what needs correcting.

@freshgum-bubbles
Copy link
Contributor

/cc @hbroek do you still want me to take a look at this? :-)

@hbroek
Copy link
Owner Author

hbroek commented Jul 3, 2023

@freshgum-bubbles, yes, please. I just added a new attribute data-ref and just focus on the new functionality

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

No branches or pull requests

2 participants