Update getting_started.md with standardized image paths and labels#43
Update getting_started.md with standardized image paths and labels#43
Conversation
Changes: - Add (getting_started)= label after line 11 for cross-references - Convert 11 image references from images/getting-started/ to _static/lecture_specific/getting_started/ for consistency - Add :figclass: auto to 10 figures (standard style) - Add :figclass: terminal to starting_nb.png (terminal screenshot) - Add :scale: 50% to debug.png per English source - Namespace all :name: attributes with gs_ prefix to avoid global label collisions (gs_jp_demo, gs_starting_nb, gs_nb, etc.) This aligns the Persian translation with the established conventions from the English source and other QuantEcon lectures.
✅ Deploy Preview for majestic-griffin-10b166 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Hi @mmcky , thanks for opening this update. I’ve reviewed the changes and here are my notes:
If you'd like me to open a follow-up PR containing these updates, just let me know and I’ll prepare it. |
|
I also wanted to briefly add two additional notes that came up during my review: |
|
thanks @Zahra-khanzadeh.
We can merge this PR into re: 324-326
This is an interesting issue, as it is an image we will need to re-generate. Would it be OK if I open an issue and we update this image after we think of a way to apply internationalisation this sort of example?
Good catch. This may need to be a manual update. I can't think of an easy way to automate this. |
- Add raw jupyter directive with QuantEcon header banner
- Add index roles for Python, Anaconda, IPython, Jupyter, JupyterLab, QuantEcon
- Add target labels: install_anaconda, ipython_notebook, a_test_program, gs_help, gs_qe, gs_install_qe
- Add {ref} cross-reference to Docstrings
- Translate secondary index terms to Persian (راهاندازی, مبانی, راهنما, اشکالزدایی, اشتراکگذاری)
- Keep proper nouns in English for index entries
|
Added MyST structural elements to Added:
Translation approach for index entries:
Not added (per discussion):
|
|
Thanks @mmcky , this all looks good to me.
Yes, I agree with the changes, please go ahead and merge this PR into
I’ll update the Persian text accordingly in a follow-up PR. |
|
thanks so much @Zahra-khanzadeh |
Summary
This PR updates
getting_started.mdto align with established conventions from the English source and other QuantEcon lectures.Changes
1. Cross-reference Label
(getting_started)=label after line 11 to enable cross-references to this lecture2. Image Path Standardization
Converted all 11 image references from the non-standard path format to the established convention:
images/getting-started/*.pngwith markdown image syntax_static/lecture_specific/getting_started/*.pngwith MyST figure directiveThis ensures consistency with other lectures and the static asset organization.
3. Figure Classes
Added
:figclass:attributes matching the English source::figclass: auto- 10 figures (standard styling):figclass: terminal- 1 figure (starting_nb.png- terminal screenshot)4. Image Scaling
:scale: 50%todebug.pngper English source5. Label Namespacing
All
:name:attributes now use thegs_prefix to avoid global label collisions:gs_jp_demo,gs_starting_nb,gs_nb,gs_nb2,gs_nb3gs_nb6,gs_nb6a,gs_nb7,gs_nb8gs_debug,gs_debugger_breakpointReview Notes
This is a formatting/convention update only - the Persian translation content remains unchanged. Please review:
gs_namespace prefix appropriate?