Skip to content

Replace docfx xref with direct links in markdown #26

@dbeuchler

Description

@dbeuchler

Right now we have a lot of broken links which just make browsing navigation harder. Even if we bring it back, UID does not work locally and does not work for anyone who just browses the repo. Since docfx also supports relative file links a suggestion is dumping UID and using plain markdown.

Removing the uids has the following disadvantages:

  • Sometimes there are links between pathes that are very long and hard to understand
  • API references cannot be linked by path and must have a uid
  • Refactorings in documentation are getting harder because you must know which file is linking to the moved file
  • The plan was to generate a complete documentation for moryx and not for each project itself. So you must know pathes from other repos. This is impossible.
  • Our documentation gets bigger an bigger and browing it by files is confusing anyway
  • Local hosting is very easy by .\Build.ps1 -GenerateDocs
  • Mapping of sourcecode to documentation does not work in plain markdown
  • Docfx has a very well working search implementation
  • We should definitly work on hosting the documentation and link from this repo. Have a look at projects like https://github.com/dotnet/docs - it is a very well structured documentation. It can be browsed in repository but links also not work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions