therenegadecoder / sample-programs-wiki Goto Github PK

I just had this wonderful idea to include information about testing in the READMEs. If testing exists, we should show everybody what version were testing with. If not, we should show users how to provide testing. Also, we should probably indicate if a program is not currently tested (though we'd like testing before we accept knew snippets, so this last point is moot.)

In addition to # of languages and # of snippets, I'd be interested in counting the total number of languages with test support:

Currently, we already have support for tests in the language tables. Adding totaling in those tables would be great as well.

Ideally, I'd like to be able to pip this script into the other repo, so we don't have to clone this repo just for the file. But, this is a change for much later.

To do this, we'll need to track a few commands:

python3 setup.py sdist bdist_wheel
twine upload dist/*

In case those commands aren't enough:

python3 -m pip install --user --upgrade setuptools wheel
python3 -m pip install --user --upgrade twine

After removing the markdown code, I realized that it would be really cool to separate out the Repo object, so folks could use it for a variety of reasons. In general, it would just be a nice way of interfacing with the Sample Programs collection.

It would be cool if the wiki included info about testing capabilities for languages.

I like these tables and whatnot. Let's just push this off to the official site.

Because of the repo infrastructure already established in this script, I thought it would be easy to add README generation. I want to automate this because it's a huge pain in the ass by hand, and a ton of our contributors have ignored the requirement in the past—causing a lot of maintenance pain.

At the moment, my plan is to loop it into wiki generation. Probably going to rename this doc generator or something. Regardless, I think I want to use it at the pull request stage rather than the deploy stage (currently), so the updated README will show up in the pull request. You can see a working example of this in the website repo where I already do this for images.

The only catch is that any changes to the script will result in a complete update to all of the READMEs. This could be annoying with many pull requests. I think the solution at the moment is one of the following:

1. Build READMEs at deployment: I don't like this because it ruins the clean squashing that we're doing now.
2. Specify the version of the doc generator in CI: this way, we can update the version and update all READMEs at the same time.

I'm opting for the latter, and I'm thinking this will have to be implemented on the website side at some point as well.

Currently, I'm writing the 250 Code Snippet release by hand, and it feels like a collosal waste of time. I'd like to be able to automate it if possible by providing a previous release tag. It should just generate the table for me after that including diffs.

In addition to Alphabetical and Chronological pages, I'd like a solutions page which details the various scripts in the repository and how many their are. Then, each solution should link to a page with all the languages that cover that particular solution.

As nice as this feature would be, it's not totally practical as the naming conventions aren't 100% consistent between languages. We'll probably need to scan for certain naming conventions (snake case vs. camel case vs. etc.). That way, it's still automated, and we're not hardcoding the solutions into the wiki script.

We're currently planning to start nesting our solutions in folders, so each solution can have multiple alternatives. As a result, this tool will need to be updated to support the change.

Currently, we have directions for cloning and running scripts. Let's add a pip section.

I was just checking the wiki after a slew of changes thanks to Hacktoberfest, and I noticed the table is not alphabetized. We'll have to dig into this: https://github.com/TheRenegadeCoder/sample-programs/wiki/Alphabetical-Language-Catalog.

The final change I would like to make to this repo is to split the three documentation tools out into their own repos. I think this one can be restored to its former glory of wiki only.

Currently, we generate the wiki inside the Sample Programs repo, and I just find that incredibly clunky. I'd like to move that logic here if possible.

Probably going to leave the Travis CI logic in Sample Programs that way we can use it to trigger Wiki/Website builds and whatnot in the future.

Whoops! See here for details: https://github.com/TheRenegadeCoder/sample-programs/wiki/O

In its current state, this script will not run. I'd like to force the user to supply an input path, so we can run this script from anywhere.

I just had a cool idea to include a disclaimer at the bottom of every README and Wiki page that reads something like the following:

This page was generated automatically by the Sample Programs Docs Generator. Find out how to support this project here (link).

I'd like to reorganize the wiki code to leverage tree data structure for the pages, so we can navigate the tree like a typical file structure. Also, this will come in handy for #13.

Currently, we automate everything in the wiki by letter. I'd be interested in generating a second set of pages based on language year. I think we can do that by parsing the READMEs for the Debut keyword.

See notes from #299.

I'm in the process of drafting the 250 language release for the Sample Programs repo, and I noticed our original table is not sorted properly (first letter sorting only). All letter sets are out of order however. See https://github.com/TheRenegadeCoder/sample-programs/wiki/C for an example.

I'm cleaning up all the tag pages on my site, and I think this project should stand separate of my personal site. In other words, this following snippet of code should change:

self.tag_url_base: str = "https://therenegadecoder.com/tag/"

to this:

self.tag_url_base: str = "https://sample-programs.therenegadecoder.com/languages/"

One thing I've noticed is that several programming language that contain multiple terms like c-plus-plus retain their hyphens in the READMEs. I would like to resolve this issue shortly.

I'd like to automate the sidebar as well.

See the Lua README: https://github.com/TheRenegadeCoder/sample-programs/tree/main/archive/l/lua

To aid in some of the analytics of this repo, I'd like to start tracking the number of scripts per language and total them in their respective tables. Then, we can transfer that data to the master tables.

Did I mention I love data?

I noticed that the YML code makes use of tabs which apparently alerts the guards in YML. This will need to be fixed up at some point.