Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move Compilation.md from Wiki #508

Merged
merged 2 commits into from
Jan 28, 2019
Merged

Conversation

AirQuick
Copy link
Member

@AirQuick AirQuick commented Jan 26, 2019

This pull request copies Compilation.md from the latest Wiki.

  • Why this PR is necessary is demonstrated in Add x:variable to schema and improve compiler support for x:variable #475:
    • We need to propose changes to documentation and example files at once
    • And then we need to collaborate on the proposed changes
  • I don't think this PR will affect user-friendliness of documentation. Compilation.md talks about the internal details. The other docs in the current Wiki focus more on the ordinary usage.
  • I chose tutorial/under-the-food/ just because I couldn't find a better place among the existing directories.
  • Compilation.md in this pull request is an exact copy of the latest Wiki.

Further work

  • Remove Compilation.md from Wiki repository and its sidebar.
  • Somewhere in How XSpec works, put a hyperlink to https://github.com/xspec/xspec/tree/master/tutorial/under-the-hood/.

xspec/xspec.wiki@5e34a55303928b9cc92f10f07f886128ca7a44bf
Copy link
Member

@galtm galtm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me. Thanks for taking care of this.

Copy link
Member

@cirulls cirulls left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good to me and improves the documentation.

@AirQuick AirQuick added this to the v1.2.0 milestone Jan 28, 2019
@AirQuick AirQuick merged commit e15be49 into xspec:master Jan 28, 2019
@AirQuick AirQuick deleted the compilation-doc branch January 28, 2019 09:43
@AirQuick
Copy link
Member Author

@cirulls @galtm Thanks, merged.

@AirQuick
Copy link
Member Author

Remove Compilation.md from Wiki repository and its sidebar.

Done

@AirQuick
Copy link
Member Author

Somewhere in How XSpec works, put a hyperlink

Done

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

Successfully merging this pull request may close these issues.

None yet

3 participants