My Mistake...
In case you missed the last post, I would like to re-state:
For this release I messed up very badly. I messed up my due date for this release in my calendar thinking it was for the 30th instead of the 20th. I also completely forgot that I had to contribute to this release, it entirely skipped my mind. That being said, I did the best I could before the deadline to get some progress in, completing 2 PR's, one of which was really fun, and 1 of which required research.
Issue...
The issue for this second PR was for an app called OEV-docs. I saw an issue regarding some links needing to be updated to not redirect to a 404 page, and instead redirect to something more informative. In this case their main pages were /dapp/overview and /oev-searchers/overview. Searching for just /dapp and /oev-searchers resulted in 404 errors on the site. It had not been assigned to anyone and as I was running out of time due to my own mistakes, so I decided to complete the requested changes and push a PR anyway to see how it would go.
I also had another repo that I was set to work on, adding unit tests to a project. However, that maintainer hadn't got back to me in time and I had not yet made any tests for it, so I did not force a second PR through like I did with this one, which I admit is kind of reckless.
Problems...
The first problem I faced was not having ever worked on a VitePress project before. Everything was in markdown syntax and required pnpm commands which I had not worked on before. I had to do some research into VitePress routing, and had a little help from copilot to fix some mistakes I made as I was not 100% familiar with the environment still. In the end I was able to complete the requested issue.
The second problem was that of not being approved for the issue. I basically completed it and let them know that it was done. I only did this as the solution was minimal in terms of it did not impact a lot of their doings, but it did help significantly from what I was able to test.
Solutions...
I had to create an index.md for the root folders of /dapp and /oev-searchers. Inside these files I made sure with a script tag that if the window was undefined which would normally lead to a 404 error that it would instead redirect to the respective /overview links.
Example of /dapp/index.md:
PR...
At the time of writing my PR is still awaiting approval. I am not sure if it will be, but the maintainers have seen my code in some capacity and I am staying optimistic of the situation.
Overall...
Overall this was an experience that could have been handled a lot better by me given I had allowed myself more time and didn't mess up this badly with my scheduling. However the maintainers seem like good people who know what they are doing, despite a slight miscommunication between me and one of the maintainers on what my changes actually are. The maintainer thought that I edited a file that was in a directory as a result of an error which would break existing links, but I had created the file intentionally and tested that links were not harmed. I hope the maintainer at this time will review my code a second time and let me know of any updates, but overall this was a good experience to learn something new such as VitePress.
Top comments (0)