search

aleixalcacer / archetypes

Scikit-learn compatible package for archetypal analysis.
https://archetypes.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
19 stars 6 forks source link

[ISSUE #17] Improve the tutorials section in docs #37

Closed Whitegabriella789 closed 4 months ago

Whitegabriella789 commented 4 months ago

Here's the second tutorial improvement. Now that the example walkthroughs/tutorials are done, I'll be improving the "Tutorials" doc. I'll have it on standby while the PRs are reviewed for any need of correction. The new doc is under "getting started."

fixed #17

aleixalcacer commented 4 months ago

From what I can see, it seems you don't have much experience using Git and GitHub. I would recommend that you first experiment with a personal project to learn the basics. Could you explain why you have created two Pull Requests (#36 and #37)?

Additionally, you need to work directly with the notebooks. Do not add two Markdown files. Simply add text cells to the Jupyter notebook explaining what is being done at each step. The notebook is automatically converted to formats like this: https://archetypes.readthedocs.io/en/latest/getting_started/examples/aa.html

If you have any questions, please don't hesitate to ask. I'm here to help!

Whitegabriella789 commented 4 months ago

My apologies. I am still new to Git and GitHub, but I have experimented with personal projects, two of which are still on my profile and the others deleted. I have taken courses, which I'm afraid may have taught me a couple of things that led to these blunders. I was taught that with each change, you submit a PR, and so with each doc I added, I submitted a separate PR. #36 does have both docs, however. I'm trying to contribute to projects so I can learn the best practices on GitHub with contributions not taught to me in lectures so I can get some experience working with others on it. I apologize for the confusion and appreciate your patience.

As for creating the Markdown files, I was also taught that documentation on GitHub typically is done in Markdown, and I wrongfully assumed that because the repo already has the Jupyter examples, I'd simply be adding documentation for those, which is why I linked them on the docs. I'll quickly fix that mistake and add the tutorial changes in text cells to the Jupyter notebooks. In the meantime, I'll update the existing Tutorials doc, which is .md, and link the existing examples for now. I'll send the PR for that now. Once again, I'm sorry for the confusion, and thank you for your help.