Skip to content

Conversation

@mmcky
Copy link
Contributor

@mmcky mmcky commented Dec 4, 2025

Summary

This PR updates getting_started.md to align with established conventions from the English source and other QuantEcon lectures.

Changes

1. Cross-reference Label

  • Added (getting_started)= label after line 11 to enable cross-references to this lecture

2. Image Path Standardization

Converted all 11 image references from the non-standard path format to the established convention:

  • Before: images/getting-started/*.png with markdown image syntax
  • After: _static/lecture_specific/getting_started/*.png with MyST figure directive

This 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

  • Added :scale: 50% to debug.png per English source

5. Label Namespacing

All :name: attributes now use the gs_ prefix to avoid global label collisions:

  • gs_jp_demo, gs_starting_nb, gs_nb, gs_nb2, gs_nb3
  • gs_nb6, gs_nb6a, gs_nb7, gs_nb8
  • gs_debug, gs_debugger_breakpoint

Review Notes

This is a formatting/convention update only - the Persian translation content remains unchanged. Please review:

  1. Are the image paths correct for all 11 figures?
  2. Are there any additional attributes needed from the English source?
  3. Is the gs_ namespace prefix appropriate?

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.
@netlify
Copy link

netlify bot commented Dec 4, 2025

Deploy Preview for majestic-griffin-10b166 ready!

Name Link
🔨 Latest commit 529d943
🔍 Latest deploy log https://app.netlify.com/projects/majestic-griffin-10b166/deploys/69409aa982bfc4000804c04a
😎 Deploy Preview https://deploy-preview-43--majestic-griffin-10b166.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link

github-actions bot commented Dec 4, 2025

@github-actions github-actions bot temporarily deployed to pull request December 4, 2025 23:15 Inactive
@Zahra-khanzadeh
Copy link
Contributor

  1. Are the image paths correct for all 11 figures?
  2. Are there any additional attributes needed from the English source?
  3. Is the gs_ namespace prefix appropriate?

Hi @mmcky , thanks for opening this update.

I’ve reviewed the changes and here are my notes:

  1. Image paths
    All image paths are correct and consistent with the standard _static/lecture_specific/... convention.

  2. Additional attributes from the English source
    There were a few structural elements from the English lecture that had not yet been included in the Persian version, such as section labels and {index} directives (for example (install_anaconda)=).
    I reviewed the English source carefully and incorporated the missing elements into my local copy so that the Persian file now fully aligns with the English version.
    If helpful, I can open a small follow-up PR with these updates so you can review them directly.

  3. Namespace prefix
    The gs_ prefix works well and is appropriate, no issues here.

If you'd like me to open a follow-up PR containing these updates, just let me know and I’ll prepare it.

@Zahra-khanzadeh
Copy link
Contributor

I also wanted to briefly add two additional notes that came up during my review:
1.For lines 324–326 in getting_started.md, the examples are short code-like expressions that should ideally be displayed left-to-right. Would you be open to placing each of these lines inside separate code cells? That way, the rendering becomes correct and users can read them without confusion.
2.I wanted to confirm one point regarding the theme:
In the English version, the text says “Most of our lectures include a ‘Launch notebook’ button (with a play icon) on the top right…”.
In the Persian layout, the icon appears on the left.
If the theme placement is final, I will update the Persian translation accordingly so the description matches the visual UI.

@mmcky
Copy link
Contributor Author

mmcky commented Dec 15, 2025

thanks @Zahra-khanzadeh.

If helpful, I can open a small follow-up PR with these updates so you can review them directly.

We can merge this PR into main if you agree with the changes.

re: 324-326

_static/lecture_specific/getting_started/nb8.png

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?

In the Persian layout, the icon appears on the left.

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
@mmcky
Copy link
Contributor Author

mmcky commented Dec 15, 2025

Added MyST structural elements to lectures/getting_started.md to align with the English version:

Added:

  • {raw} jupyter directive with QuantEcon header banner
  • {index} roles for: Python, Anaconda, IPython, Jupyter, JupyterLab, QuantEcon, nbviewer
  • Target labels: (install_anaconda)=, (ipython_notebook)=, (a_test_program)=, (gs_help)=, (gs_qe)=, (gs_install_qe)=
  • {ref} cross-reference to Docstrings

Translation approach for index entries:

  • Proper nouns kept in English: Python, Jupyter, IPython, Anaconda, QuantEcon, JupyterLab, nbviewer
  • Secondary/descriptive terms translated to Persian:
    • Setup → راه‌اندازی
    • Basics → مبانی
    • Help → راهنما
    • Debugging → اشکال‌زدایی
    • Sharing → اشتراک‌گذاری

Not added (per discussion):

  • <style> block (not standard in English series)
  • Figure path changes (kept as-is)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants