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

Pull md files from doc source repo instead of wiki #251

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

AlanDrake
Copy link
Contributor

Preliminary step to #242:

  • Linking to another repo instead of the wiki.
  • Added an edit link to github above the footer.

Notes:

  • links from github preview don't work because it expects a .md extension
  • since the source is still pulled through a submodule, we still have the same pro/con as before that it checks out the same submodule version which was committed

@ericoporto
Copy link
Member

links from github preview don't work because it expects a .md extension

I can't understand what this line means...What is GitHub Preview?

@AlanDrake AlanDrake mentioned this pull request Jul 19, 2024
@AlanDrake
Copy link
Contributor Author

AlanDrake commented Jul 19, 2024

What is GitHub Preview?

The preview from the normal file editor. It's almost the same to the wiki editor, but they treat links differently.

@ivan-mogilko
Copy link
Contributor

I have a question, how is the manual-source repo updated currently? is it synced with .wiki automatically, or someone cherry picks the commits?

@ericoporto
Copy link
Member

Right now it's done manually and I think the idea would be in the future to remove the wiki and work all in the repository.

This is only part of the problem, there is still the issue of figuring what to do with the online ags-manual. I think the idea is once at least the sources of the manual is using a regular repository at least on that side branches are more useful and then it would be on this side figuring what to do with the different branches.

@AlanDrake
Copy link
Contributor Author

Yes, I was currently syncing manually until this PR is merged, moving the editing inside the branch md files, so we can also make new branch for ags4.

Once we have two branches, we can see how to deal with multiple versions of the docs and bundling them to the editor releases.

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.

3 participants