Spoiler alert, don’t do it
I wrote some high level and low level markdown summaries for my aviation kaggle data sciency project. I placed them in the github repo of the project itself. Today I have been thinking about how to best build the Github Pages repo to showcase those markdowns that live in that other repository.
Looking for inspiration, I saw this author has chosen to have a typical github.io repo and also a separate portfolio repo. On the other hand this author’s approach was to maintain any source python notebook and markdown files within the main GithubPages repo itself.
For my other two projects, bam and babam, I ended up manually copying my README.md and what have you. I felt dirty doing it that way with all of the copy-pasta!
Having recently read Richard Hamming’s 1986 seminar on dopeness, the part that stuck with me the most was his notion of generalizability. I am paraphrasing, but he emphasized doing things with a multiplier effect. Ok now actually quoting, “Instead of attacking isolated problems, I made the resolution that I would never again solve an isolated problem except as characteristic of a class.” What a cry for open source this is. Anyway so living with intention, I am going to relocate my notes into the main Github Pages repo. What a transition!
A repo should still keep its README for sure, so I suppose that level of duplication is just unavoidable.